Rename substructure for ease of debugging
[exim.git] / src / src / deliver.c
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
5a66c31b 5/* Copyright (c) University of Cambridge 1995 - 2014 */
059ec3d9
PH
6/* See the file NOTICE for conditions of use and distribution. */
7
8/* The main code for delivering a message. */
9
10
11#include "exim.h"
12
13
14/* Data block for keeping track of subprocesses for parallel remote
15delivery. */
16
17typedef struct pardata {
18 address_item *addrlist; /* chain of addresses */
19 address_item *addr; /* next address data expected for */
20 pid_t pid; /* subprocess pid */
21 int fd; /* pipe fd for getting result from subprocess */
22 int transport_count; /* returned transport count value */
23 BOOL done; /* no more data needed */
24 uschar *msg; /* error message */
25 uschar *return_path; /* return_path for these addresses */
26} pardata;
27
28/* Values for the process_recipients variable */
29
30enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
31 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
32 RECIP_FAIL_LOOP};
33
34/* Mutually recursive functions for marking addresses done. */
35
36static void child_done(address_item *, uschar *);
37static void address_done(address_item *, uschar *);
38
39/* Table for turning base-62 numbers into binary */
40
41static uschar tab62[] =
42 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
43 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
44 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
45 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
46 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
47 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
48 59,60,61}; /* x-z */
49
50
51/*************************************************
52* Local static variables *
53*************************************************/
54
55/* addr_duplicate is global because it needs to be seen from the Envelope-To
56writing code. */
57
58static address_item *addr_defer = NULL;
59static address_item *addr_failed = NULL;
60static address_item *addr_fallback = NULL;
61static address_item *addr_local = NULL;
62static address_item *addr_new = NULL;
63static address_item *addr_remote = NULL;
64static address_item *addr_route = NULL;
65static address_item *addr_succeed = NULL;
6c1c3d1d
WB
66static address_item *addr_dsntmp = NULL;
67static address_item *addr_senddsn = NULL;
059ec3d9
PH
68
69static FILE *message_log = NULL;
70static BOOL update_spool;
71static BOOL remove_journal;
72static int parcount = 0;
73static pardata *parlist = NULL;
74static int return_count;
75static uschar *frozen_info = US"";
76static uschar *used_return_path = NULL;
77
78static uschar spoolname[PATH_MAX];
79
80
81
82/*************************************************
83* Make a new address item *
84*************************************************/
85
86/* This function gets the store and initializes with default values. The
87transport_return value defaults to DEFER, so that any unexpected failure to
88deliver does not wipe out the message. The default unique string is set to a
89copy of the address, so that its domain can be lowercased.
90
91Argument:
92 address the RFC822 address string
93 copy force a copy of the address
94
95Returns: a pointer to an initialized address_item
96*/
97
98address_item *
99deliver_make_addr(uschar *address, BOOL copy)
100{
101address_item *addr = store_get(sizeof(address_item));
102*addr = address_defaults;
103if (copy) address = string_copy(address);
104addr->address = address;
105addr->unique = string_copy(address);
106return addr;
107}
108
109
110
111
112/*************************************************
113* Set expansion values for an address *
114*************************************************/
115
116/* Certain expansion variables are valid only when handling an address or
117address list. This function sets them up or clears the values, according to its
118argument.
119
120Arguments:
121 addr the address in question, or NULL to clear values
122Returns: nothing
123*/
124
125void
126deliver_set_expansions(address_item *addr)
127{
128if (addr == NULL)
129 {
55414b25 130 const uschar ***p = address_expansions;
059ec3d9
PH
131 while (*p != NULL) **p++ = NULL;
132 return;
133 }
134
135/* Exactly what gets set depends on whether there is one or more addresses, and
136what they contain. These first ones are always set, taking their values from
137the first address. */
138
139if (addr->host_list == NULL)
140 {
141 deliver_host = deliver_host_address = US"";
a7538db1 142 deliver_host_port = 0;
059ec3d9
PH
143 }
144else
145 {
146 deliver_host = addr->host_list->name;
147 deliver_host_address = addr->host_list->address;
a7538db1 148 deliver_host_port = addr->host_list->port;
059ec3d9
PH
149 }
150
151deliver_recipients = addr;
d43cbe25
JH
152deliver_address_data = addr->prop.address_data;
153deliver_domain_data = addr->prop.domain_data;
154deliver_localpart_data = addr->prop.localpart_data;
059ec3d9
PH
155
156/* These may be unset for multiple addresses */
157
158deliver_domain = addr->domain;
159self_hostname = addr->self_hostname;
160
8523533c
TK
161#ifdef EXPERIMENTAL_BRIGHTMAIL
162bmi_deliver = 1; /* deliver by default */
163bmi_alt_location = NULL;
164bmi_base64_verdict = NULL;
165bmi_base64_tracker_verdict = NULL;
166#endif
167
059ec3d9
PH
168/* If there's only one address we can set everything. */
169
170if (addr->next == NULL)
171 {
172 address_item *addr_orig;
173
174 deliver_localpart = addr->local_part;
175 deliver_localpart_prefix = addr->prefix;
176 deliver_localpart_suffix = addr->suffix;
177
178 for (addr_orig = addr; addr_orig->parent != NULL;
179 addr_orig = addr_orig->parent);
180 deliver_domain_orig = addr_orig->domain;
181
182 /* Re-instate any prefix and suffix in the original local part. In all
183 normal cases, the address will have a router associated with it, and we can
184 choose the caseful or caseless version accordingly. However, when a system
185 filter sets up a pipe, file, or autoreply delivery, no router is involved.
186 In this case, though, there won't be any prefix or suffix to worry about. */
187
188 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
189 addr_orig->router->caseful_local_part?
190 addr_orig->cc_local_part : addr_orig->lc_local_part;
191
192 /* If there's a parent, make its domain and local part available, and if
193 delivering to a pipe or file, or sending an autoreply, get the local
194 part from the parent. For pipes and files, put the pipe or file string
195 into address_pipe and address_file. */
196
197 if (addr->parent != NULL)
198 {
199 deliver_domain_parent = addr->parent->domain;
200 deliver_localpart_parent = (addr->parent->router == NULL)?
201 addr->parent->local_part :
202 addr->parent->router->caseful_local_part?
203 addr->parent->cc_local_part : addr->parent->lc_local_part;
204
205 /* File deliveries have their own flag because they need to be picked out
206 as special more often. */
207
208 if (testflag(addr, af_pfr))
209 {
210 if (testflag(addr, af_file)) address_file = addr->local_part;
211 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
212 deliver_localpart = addr->parent->local_part;
213 deliver_localpart_prefix = addr->parent->prefix;
214 deliver_localpart_suffix = addr->parent->suffix;
215 }
216 }
8523533c
TK
217
218#ifdef EXPERIMENTAL_BRIGHTMAIL
219 /* Set expansion variables related to Brightmail AntiSpam */
220 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
221 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
222 /* get message delivery status (0 - don't deliver | 1 - deliver) */
223 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
224 /* if message is to be delivered, get eventual alternate location */
225 if (bmi_deliver == 1) {
226 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
227 };
228#endif
229
059ec3d9
PH
230 }
231
232/* For multiple addresses, don't set local part, and leave the domain and
f7fd3850
PH
233self_hostname set only if it is the same for all of them. It is possible to
234have multiple pipe and file addresses, but only when all addresses have routed
235to the same pipe or file. */
059ec3d9
PH
236
237else
238 {
239 address_item *addr2;
f7fd3850
PH
240 if (testflag(addr, af_pfr))
241 {
242 if (testflag(addr, af_file)) address_file = addr->local_part;
243 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
244 }
059ec3d9
PH
245 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
246 {
247 if (deliver_domain != NULL &&
248 Ustrcmp(deliver_domain, addr2->domain) != 0)
249 deliver_domain = NULL;
250 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
251 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
252 self_hostname = NULL;
253 if (deliver_domain == NULL && self_hostname == NULL) break;
254 }
255 }
256}
257
258
259
260
261/*************************************************
262* Open a msglog file *
263*************************************************/
264
265/* This function is used both for normal message logs, and for files in the
266msglog directory that are used to catch output from pipes. Try to create the
267directory if it does not exist. From release 4.21, normal message logs should
268be created when the message is received.
269
270Argument:
271 filename the file name
272 mode the mode required
273 error used for saying what failed
274
275Returns: a file descriptor, or -1 (with errno set)
276*/
277
278static int
279open_msglog_file(uschar *filename, int mode, uschar **error)
280{
281int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
282
283if (fd < 0 && errno == ENOENT)
284 {
285 uschar temp[16];
286 sprintf(CS temp, "msglog/%s", message_subdir);
287 if (message_subdir[0] == 0) temp[6] = 0;
288 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
289 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
290 }
291
292/* Set the close-on-exec flag and change the owner to the exim uid/gid (this
293function is called as root). Double check the mode, because the group setting
294doesn't always get set automatically. */
295
296if (fd >= 0)
297 {
ff790e47 298 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
059ec3d9
PH
299 if (fchown(fd, exim_uid, exim_gid) < 0)
300 {
301 *error = US"chown";
302 return -1;
303 }
304 if (fchmod(fd, mode) < 0)
305 {
306 *error = US"chmod";
307 return -1;
308 }
309 }
310else *error = US"create";
311
312return fd;
313}
314
315
316
317
318/*************************************************
319* Write to msglog if required *
320*************************************************/
321
322/* Write to the message log, if configured. This function may also be called
323from transports.
324
325Arguments:
326 format a string format
327
328Returns: nothing
329*/
330
331void
332deliver_msglog(const char *format, ...)
333{
334va_list ap;
335if (!message_logs) return;
336va_start(ap, format);
337vfprintf(message_log, format, ap);
338fflush(message_log);
339va_end(ap);
340}
341
342
343
344
345/*************************************************
346* Replicate status for batch *
347*************************************************/
348
349/* When a transport handles a batch of addresses, it may treat them
350individually, or it may just put the status in the first one, and return FALSE,
351requesting that the status be copied to all the others externally. This is the
352replication function. As well as the status, it copies the transport pointer,
353which may have changed if appendfile passed the addresses on to a different
354transport.
355
356Argument: pointer to the first address in a chain
357Returns: nothing
358*/
359
360static void
361replicate_status(address_item *addr)
362{
363address_item *addr2;
364for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
365 {
366 addr2->transport = addr->transport;
367 addr2->transport_return = addr->transport_return;
368 addr2->basic_errno = addr->basic_errno;
369 addr2->more_errno = addr->more_errno;
370 addr2->special_action = addr->special_action;
371 addr2->message = addr->message;
372 addr2->user_message = addr->user_message;
373 }
374}
375
376
377
378/*************************************************
379* Compare lists of hosts *
380*************************************************/
381
382/* This function is given two pointers to chains of host items, and it yields
383TRUE if the lists refer to the same hosts in the same order, except that
384
385(1) Multiple hosts with the same non-negative MX values are permitted to appear
386 in different orders. Round-robinning nameservers can cause this to happen.
387
388(2) Multiple hosts with the same negative MX values less than MX_NONE are also
389 permitted to appear in different orders. This is caused by randomizing
390 hosts lists.
391
392This enables Exim to use a single SMTP transaction for sending to two entirely
393different domains that happen to end up pointing at the same hosts.
394
395Arguments:
396 one points to the first host list
397 two points to the second host list
398
399Returns: TRUE if the lists refer to the same host set
400*/
401
402static BOOL
403same_hosts(host_item *one, host_item *two)
404{
405while (one != NULL && two != NULL)
406 {
407 if (Ustrcmp(one->name, two->name) != 0)
408 {
409 int mx = one->mx;
410 host_item *end_one = one;
411 host_item *end_two = two;
412
413 /* Batch up only if there was no MX and the list was not randomized */
414
415 if (mx == MX_NONE) return FALSE;
416
417 /* Find the ends of the shortest sequence of identical MX values */
418
419 while (end_one->next != NULL && end_one->next->mx == mx &&
420 end_two->next != NULL && end_two->next->mx == mx)
421 {
422 end_one = end_one->next;
423 end_two = end_two->next;
424 }
425
426 /* If there aren't any duplicates, there's no match. */
427
428 if (end_one == one) return FALSE;
429
430 /* For each host in the 'one' sequence, check that it appears in the 'two'
431 sequence, returning FALSE if not. */
432
433 for (;;)
434 {
435 host_item *hi;
436 for (hi = two; hi != end_two->next; hi = hi->next)
437 if (Ustrcmp(one->name, hi->name) == 0) break;
438 if (hi == end_two->next) return FALSE;
439 if (one == end_one) break;
440 one = one->next;
441 }
442
443 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
444 Ensure both are pointing at the last host, and carry on as for equality. */
445
446 two = end_two;
447 }
448
449 /* Hosts matched */
450
451 one = one->next;
452 two = two->next;
453 }
454
455/* True if both are NULL */
456
457return (one == two);
458}
459
460
461
462/*************************************************
463* Compare header lines *
464*************************************************/
465
466/* This function is given two pointers to chains of header items, and it yields
467TRUE if they are the same header texts in the same order.
468
469Arguments:
470 one points to the first header list
471 two points to the second header list
472
473Returns: TRUE if the lists refer to the same header set
474*/
475
476static BOOL
477same_headers(header_line *one, header_line *two)
478{
479for (;;)
480 {
481 if (one == two) return TRUE; /* Includes the case where both NULL */
482 if (one == NULL || two == NULL) return FALSE;
483 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
484 one = one->next;
485 two = two->next;
486 }
487}
488
489
490
491/*************************************************
492* Compare string settings *
493*************************************************/
494
495/* This function is given two pointers to strings, and it returns
496TRUE if they are the same pointer, or if the two strings are the same.
497
498Arguments:
499 one points to the first string
500 two points to the second string
501
502Returns: TRUE or FALSE
503*/
504
505static BOOL
506same_strings(uschar *one, uschar *two)
507{
508if (one == two) return TRUE; /* Includes the case where both NULL */
509if (one == NULL || two == NULL) return FALSE;
510return (Ustrcmp(one, two) == 0);
511}
512
513
514
515/*************************************************
516* Compare uid/gid for addresses *
517*************************************************/
518
519/* This function is given a transport and two addresses. It yields TRUE if the
520uid/gid/initgroups settings for the two addresses are going to be the same when
521they are delivered.
522
523Arguments:
524 tp the transort
525 addr1 the first address
526 addr2 the second address
527
528Returns: TRUE or FALSE
529*/
530
531static BOOL
532same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
533{
534if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
535 {
536 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
537 (testflag(addr1, af_uid_set) &&
538 (addr1->uid != addr2->uid ||
539 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
540 return FALSE;
541 }
542
543if (!tp->gid_set && tp->expand_gid == NULL)
544 {
545 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
546 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
547 return FALSE;
548 }
549
550return TRUE;
551}
552
553
554
555
556/*************************************************
557* Record that an address is complete *
558*************************************************/
559
560/* This function records that an address is complete. This is straightforward
561for most addresses, where the unique address is just the full address with the
562domain lower cased. For homonyms (addresses that are the same as one of their
563ancestors) their are complications. Their unique addresses have \x\ prepended
564(where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
565cousins.
566
567Exim used to record the unique addresses of homonyms as "complete". This,
568however, fails when the pattern of redirection varies over time (e.g. if taking
569unseen copies at only some times of day) because the prepended numbers may vary
570from one delivery run to the next. This problem is solved by never recording
571prepended unique addresses as complete. Instead, when a homonymic address has
572actually been delivered via a transport, we record its basic unique address
573followed by the name of the transport. This is checked in subsequent delivery
574runs whenever an address is routed to a transport.
575
576If the completed address is a top-level one (has no parent, which means it
577cannot be homonymic) we also add the original address to the non-recipients
578tree, so that it gets recorded in the spool file and therefore appears as
579"done" in any spool listings. The original address may differ from the unique
580address in the case of the domain.
581
582Finally, this function scans the list of duplicates, marks as done any that
583match this address, and calls child_done() for their ancestors.
584
585Arguments:
586 addr address item that has been completed
587 now current time as a string
588
589Returns: nothing
590*/
591
592static void
593address_done(address_item *addr, uschar *now)
594{
595address_item *dup;
596
597update_spool = TRUE; /* Ensure spool gets updated */
598
599/* Top-level address */
600
601if (addr->parent == NULL)
602 {
603 tree_add_nonrecipient(addr->unique);
604 tree_add_nonrecipient(addr->address);
605 }
606
607/* Homonymous child address */
608
609else if (testflag(addr, af_homonym))
610 {
611 if (addr->transport != NULL)
612 {
613 tree_add_nonrecipient(
614 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
615 }
616 }
617
618/* Non-homonymous child address */
619
620else tree_add_nonrecipient(addr->unique);
621
622/* Check the list of duplicate addresses and ensure they are now marked
623done as well. */
624
625for (dup = addr_duplicate; dup != NULL; dup = dup->next)
626 {
627 if (Ustrcmp(addr->unique, dup->unique) == 0)
628 {
57730b52 629 tree_add_nonrecipient(dup->unique);
059ec3d9
PH
630 child_done(dup, now);
631 }
632 }
633}
634
635
636
637
638/*************************************************
639* Decrease counts in parents and mark done *
640*************************************************/
641
642/* This function is called when an address is complete. If there is a parent
643address, its count of children is decremented. If there are still other
644children outstanding, the function exits. Otherwise, if the count has become
645zero, address_done() is called to mark the parent and its duplicates complete.
646Then loop for any earlier ancestors.
647
648Arguments:
649 addr points to the completed address item
650 now the current time as a string, for writing to the message log
651
652Returns: nothing
653*/
654
655static void
656child_done(address_item *addr, uschar *now)
657{
658address_item *aa;
659while (addr->parent != NULL)
660 {
661 addr = addr->parent;
662 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
663 address_done(addr, now);
664
665 /* Log the completion of all descendents only when there is no ancestor with
666 the same original address. */
667
668 for (aa = addr->parent; aa != NULL; aa = aa->parent)
669 if (Ustrcmp(aa->address, addr->address) == 0) break;
670 if (aa != NULL) continue;
671
672 deliver_msglog("%s %s: children all complete\n", now, addr->address);
673 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
674 }
675}
676
677
678
679
67d81c10
JH
680static uschar *
681d_hostlog(uschar * s, int * sizep, int * ptrp, address_item * addr)
682{
683 s = string_append(s, sizep, ptrp, 5, US" H=", addr->host_used->name,
684 US" [", addr->host_used->address, US"]");
685 if ((log_extra_selector & LX_outgoing_port) != 0)
686 s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
687 addr->host_used->port));
688 return s;
689}
690
691#ifdef SUPPORT_TLS
692static uschar *
693d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
694{
695 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
696 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
697 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
698 addr->cipher != NULL)
699 s = string_append(s, sizep, ptrp, 2, US" CV=",
53a7196b
JH
700 testflag(addr, af_cert_verified)
701 ?
702#ifdef EXPERIMENTAL_DANE
703 testflag(addr, af_dane_verified)
704 ? "dane"
705 :
706#endif
707 "yes"
708 : "no");
67d81c10
JH
709 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
710 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
711 string_printing(addr->peerdn), US"\"");
712 return s;
713}
714#endif
715
a7538db1 716
14a465c3
JH
717
718
774ef2d7 719#ifdef EXPERIMENTAL_EVENT
b30275b8 720uschar *
55414b25 721event_raise(uschar * action, const uschar * event, uschar * ev_data)
a7538db1
JH
722{
723uschar * s;
724if (action)
725 {
726 DEBUG(D_deliver)
774ef2d7 727 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
a7538db1
JH
728 event,
729 action, deliver_host_address);
730
774ef2d7
JH
731 event_name = event;
732 event_data = ev_data;
a7538db1
JH
733
734 if (!(s = expand_string(action)) && *expand_string_message)
735 log_write(0, LOG_MAIN|LOG_PANIC,
774ef2d7 736 "failed to expand event_action %s in %s: %s\n",
a7538db1
JH
737 event, transport_name, expand_string_message);
738
774ef2d7 739 event_name = event_data = NULL;
a7538db1
JH
740
741 /* If the expansion returns anything but an empty string, flag for
742 the caller to modify his normal processing
743 */
744 if (s && *s)
745 {
746 DEBUG(D_deliver)
774ef2d7 747 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
b30275b8 748 return s;
a7538db1
JH
749 }
750 }
b30275b8 751return NULL;
a7538db1 752}
14a465c3
JH
753
754static void
55414b25 755msg_event_raise(const uschar * event, const address_item * addr)
14a465c3 756{
55414b25 757const uschar * save_domain = deliver_domain;
14a465c3 758uschar * save_local = deliver_localpart;
55414b25 759const uschar * save_host = deliver_host;
14a465c3
JH
760
761if (!addr->transport)
762 return;
763
764router_name = addr->router ? addr->router->name : NULL;
765transport_name = addr->transport->name;
766deliver_domain = addr->domain;
767deliver_localpart = addr->local_part;
c562fd30 768deliver_host = addr->host_used ? addr->host_used->name : NULL;
14a465c3 769
774ef2d7 770(void) event_raise(addr->transport->event_action, event,
14a465c3
JH
771 addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
772 ? addr->message : NULL);
773
c562fd30 774deliver_host = save_host;
14a465c3
JH
775deliver_localpart = save_local;
776deliver_domain = save_domain;
777router_name = transport_name = NULL;
778}
774ef2d7 779#endif /*EXPERIMENTAL_EVENT*/
14a465c3
JH
780
781
a7538db1 782
817d9f57 783/* If msg is NULL this is a delivery log and logchar is used. Otherwise
67d81c10 784this is a nonstandard call; no two-character delivery flag is written
817d9f57
JH
785but sender-host and sender are prefixed and "msg" is inserted in the log line.
786
787Arguments:
788 flags passed to log_write()
789*/
e4bdf652 790void
817d9f57 791delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
e4bdf652
JH
792{
793uschar *log_address;
794int size = 256; /* Used for a temporary, */
795int ptr = 0; /* expanding buffer, for */
796uschar *s; /* building log lines; */
797void *reset_point; /* released afterwards. */
798
e4bdf652
JH
799/* Log the delivery on the main log. We use an extensible string to build up
800the log line, and reset the store afterwards. Remote deliveries should always
801have a pointer to the host item that succeeded; local deliveries can have a
802pointer to a single host item in their host list, for use by the transport. */
803
774ef2d7 804#ifdef EXPERIMENTAL_EVENT
a7538db1 805 /* presume no successful remote delivery */
783b385f 806 lookup_dnssec_authenticated = NULL;
d68218c7
JH
807#endif
808
e4bdf652 809s = reset_point = store_get(size);
e4bdf652
JH
810
811log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
817d9f57
JH
812if (msg)
813 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
814else
815 {
816 s[ptr++] = logchar;
817 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
818 }
e4bdf652 819
aeaf5db3
JH
820if (log_extra_selector & LX_incoming_interface && sending_ip_address)
821 s = string_append(s, &size, &ptr, 3, US" I=[", sending_ip_address, US"]");
822 /* for the port: string_sprintf("%d", sending_port) */
823
817d9f57 824if ((log_extra_selector & LX_sender_on_delivery) != 0 || msg)
e4bdf652
JH
825 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
826
827#ifdef EXPERIMENTAL_SRS
d43cbe25
JH
828if(addr->prop.srs_sender)
829 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->prop.srs_sender, US">");
e4bdf652
JH
830#endif
831
832/* You might think that the return path must always be set for a successful
833delivery; indeed, I did for some time, until this statement crashed. The case
834when it is not set is for a delivery to /dev/null which is optimised by not
835being run at all. */
836
837if (used_return_path != NULL &&
838 (log_extra_selector & LX_return_path_on_delivery) != 0)
839 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
840
817d9f57
JH
841if (msg)
842 s = string_append(s, &size, &ptr, 2, US" ", msg);
e4bdf652 843
817d9f57 844/* For a delivery from a system filter, there may not be a router */
e4bdf652
JH
845if (addr->router != NULL)
846 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
847
848s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
849
850if ((log_extra_selector & LX_delivery_size) != 0)
851 s = string_append(s, &size, &ptr, 2, US" S=",
852 string_sprintf("%d", transport_count));
853
854/* Local delivery */
855
856if (addr->transport->info->local)
857 {
a7538db1 858 if (addr->host_list)
e4bdf652
JH
859 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
860 if (addr->shadow_message != NULL)
861 s = string_cat(s, &size, &ptr, addr->shadow_message,
862 Ustrlen(addr->shadow_message));
863 }
864
865/* Remote delivery */
866
867else
868 {
783b385f 869 if (addr->host_used)
e4bdf652 870 {
67d81c10 871 s = d_hostlog(s, &size, &ptr, addr);
e4bdf652
JH
872 if (continue_sequence > 1)
873 s = string_cat(s, &size, &ptr, US"*", 1);
d68218c7 874
774ef2d7 875#ifdef EXPERIMENTAL_EVENT
a7538db1
JH
876 deliver_host_address = addr->host_used->address;
877 deliver_host_port = addr->host_used->port;
029f4192 878 deliver_host = addr->host_used->name;
783b385f
JH
879
880 /* DNS lookup status */
881 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
882 : addr->host_used->dnssec==DS_NO ? US"no"
883 : NULL;
a7538db1 884#endif
e4bdf652
JH
885 }
886
a7538db1 887#ifdef SUPPORT_TLS
67d81c10 888 s = d_tlslog(s, &size, &ptr, addr);
a7538db1 889#endif
e4bdf652 890
018c60d7 891 if (addr->authenticator)
6f123593 892 {
018c60d7
JH
893 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
894 if (addr->auth_id)
c8e2fc1e 895 {
018c60d7
JH
896 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
897 if (log_extra_selector & LX_smtp_mailauth && addr->auth_sndr)
898 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
c8e2fc1e 899 }
6f123593
JH
900 }
901
a7538db1 902#ifndef DISABLE_PRDR
fd98a5c6
JH
903 if (addr->flags & af_prdr_used)
904 s = string_append(s, &size, &ptr, 1, US" PRDR");
a7538db1 905#endif
76f44207
WB
906 }
907
908/* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
fd98a5c6 909
27520a68
JH
910if (log_extra_selector & LX_smtp_confirmation &&
911 addr->message &&
912 (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0))
76f44207 913 {
b980ed83 914 unsigned i;
1c5b1499 915 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
76f44207
WB
916 uschar *p = big_buffer;
917 uschar *ss = addr->message;
918 *p++ = '\"';
b980ed83 919 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
e4bdf652 920 {
27520a68 921 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
76f44207 922 *p++ = ss[i];
e4bdf652 923 }
76f44207
WB
924 *p++ = '\"';
925 *p = 0;
926 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
e4bdf652
JH
927 }
928
929/* Time on queue and actual time taken to deliver */
930
931if ((log_extra_selector & LX_queue_time) != 0)
e4bdf652 932 s = string_append(s, &size, &ptr, 2, US" QT=",
19050083 933 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
e4bdf652
JH
934
935if ((log_extra_selector & LX_deliver_time) != 0)
e4bdf652
JH
936 s = string_append(s, &size, &ptr, 2, US" DT=",
937 readconf_printtime(addr->more_errno));
e4bdf652
JH
938
939/* string_cat() always leaves room for the terminator. Release the
940store we used to build the line after writing it. */
941
942s[ptr] = 0;
817d9f57 943log_write(0, flags, "%s", s);
d68218c7 944
774ef2d7
JH
945#ifdef EXPERIMENTAL_EVENT
946if (!msg) msg_event_raise(US"msg:delivery", addr);
d68218c7 947#endif
14a465c3 948
e4bdf652
JH
949store_reset(reset_point);
950return;
951}
952
953
954
059ec3d9
PH
955/*************************************************
956* Actions at the end of handling an address *
957*************************************************/
958
959/* This is a function for processing a single address when all that can be done
960with it has been done.
961
962Arguments:
963 addr points to the address block
964 result the result of the delivery attempt
965 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
966 driver_type indicates which type of driver (transport, or router) was last
967 to process the address
968 logchar '=' or '-' for use when logging deliveries with => or ->
969
970Returns: nothing
971*/
972
973static void
974post_process_one(address_item *addr, int result, int logflags, int driver_type,
975 int logchar)
976{
977uschar *now = tod_stamp(tod_log);
978uschar *driver_kind = NULL;
979uschar *driver_name = NULL;
980uschar *log_address;
981
982int size = 256; /* Used for a temporary, */
983int ptr = 0; /* expanding buffer, for */
984uschar *s; /* building log lines; */
985void *reset_point; /* released afterwards. */
986
059ec3d9
PH
987DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
988
989/* Set up driver kind and name for logging. Disable logging if the router or
990transport has disabled it. */
991
992if (driver_type == DTYPE_TRANSPORT)
993 {
994 if (addr->transport != NULL)
995 {
996 driver_name = addr->transport->name;
997 driver_kind = US" transport";
998 disable_logging = addr->transport->disable_logging;
999 }
1000 else driver_kind = US"transporting";
1001 }
1002else if (driver_type == DTYPE_ROUTER)
1003 {
1004 if (addr->router != NULL)
1005 {
1006 driver_name = addr->router->name;
1007 driver_kind = US" router";
1008 disable_logging = addr->router->disable_logging;
1009 }
1010 else driver_kind = US"routing";
1011 }
1012
1013/* If there's an error message set, ensure that it contains only printing
1014characters - it should, but occasionally things slip in and this at least
49c2d5ea
PH
1015stops the log format from getting wrecked. We also scan the message for an LDAP
1016expansion item that has a password setting, and flatten the password. This is a
1017fudge, but I don't know a cleaner way of doing this. (If the item is badly
1018malformed, it won't ever have gone near LDAP.) */
059ec3d9 1019
49c2d5ea
PH
1020if (addr->message != NULL)
1021 {
55414b25
JH
1022 const uschar * s = string_printing(addr->message);
1023 if (s != addr->message)
1024 addr->message = US s;
1025 /* deconst cast ok as string_printing known to have alloc'n'copied */
76aa570c
PP
1026 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
1027 (Ustrstr(addr->message, "mysql") != NULL ||
1028 Ustrstr(addr->message, "pgsql") != NULL ||
9bdd29ad
TL
1029#ifdef EXPERIMENTAL_REDIS
1030 Ustrstr(addr->message, "redis") != NULL ||
1031#endif
76aa570c
PP
1032 Ustrstr(addr->message, "sqlite") != NULL ||
1033 Ustrstr(addr->message, "ldap:") != NULL ||
49c2d5ea
PH
1034 Ustrstr(addr->message, "ldapdn:") != NULL ||
1035 Ustrstr(addr->message, "ldapm:") != NULL))
1036 {
76aa570c 1037 addr->message = string_sprintf("Temporary internal error");
49c2d5ea
PH
1038 }
1039 }
059ec3d9
PH
1040
1041/* If we used a transport that has one of the "return_output" options set, and
1042if it did in fact generate some output, then for return_output we treat the
1043message as failed if it was not already set that way, so that the output gets
1044returned to the sender, provided there is a sender to send it to. For
1045return_fail_output, do this only if the delivery failed. Otherwise we just
1046unlink the file, and remove the name so that if the delivery failed, we don't
1047try to send back an empty or unwanted file. The log_output options operate only
1048on a non-empty file.
1049
1050In any case, we close the message file, because we cannot afford to leave a
1051file-descriptor for one address while processing (maybe very many) others. */
1052
1053if (addr->return_file >= 0 && addr->return_filename != NULL)
1054 {
1055 BOOL return_output = FALSE;
1056 struct stat statbuf;
54fc8428 1057 (void)EXIMfsync(addr->return_file);
059ec3d9
PH
1058
1059 /* If there is no output, do nothing. */
1060
1061 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1062 {
1063 transport_instance *tb = addr->transport;
1064
1065 /* Handle logging options */
1066
1067 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
1068 (result == DEFER && tb->log_defer_output))
1069 {
1070 uschar *s;
1071 FILE *f = Ufopen(addr->return_filename, "rb");
1072 if (f == NULL)
1073 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1074 "from %s transport: %s", addr->return_filename, tb->name,
1075 strerror(errno));
1076 else
1077 {
1078 s = US Ufgets(big_buffer, big_buffer_size, f);
1079 if (s != NULL)
1080 {
1081 uschar *p = big_buffer + Ustrlen(big_buffer);
55414b25 1082 const uschar * sp;
059ec3d9
PH
1083 while (p > big_buffer && isspace(p[-1])) p--;
1084 *p = 0;
55414b25 1085 sp = string_printing(big_buffer);
059ec3d9 1086 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
55414b25 1087 addr->address, tb->name, sp);
059ec3d9 1088 }
f1e894f3 1089 (void)fclose(f);
059ec3d9
PH
1090 }
1091 }
1092
1093 /* Handle returning options, but only if there is an address to return
1094 the text to. */
1095
d43cbe25 1096 if (sender_address[0] != 0 || addr->prop.errors_address != NULL)
059ec3d9
PH
1097 {
1098 if (tb->return_output)
1099 {
1100 addr->transport_return = result = FAIL;
1101 if (addr->basic_errno == 0 && addr->message == NULL)
1102 addr->message = US"return message generated";
1103 return_output = TRUE;
1104 }
1105 else
1106 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1107 }
1108 }
1109
1110 /* Get rid of the file unless it might be returned, but close it in
1111 all cases. */
1112
1113 if (!return_output)
1114 {
1115 Uunlink(addr->return_filename);
1116 addr->return_filename = NULL;
1117 addr->return_file = -1;
1118 }
1119
f1e894f3 1120 (void)close(addr->return_file);
059ec3d9
PH
1121 }
1122
9d1c15ef 1123/* The success case happens only after delivery by a transport. */
059ec3d9
PH
1124
1125if (result == OK)
1126 {
1127 addr->next = addr_succeed;
1128 addr_succeed = addr;
1129
1130 /* Call address_done() to ensure that we don't deliver to this address again,
1131 and write appropriate things to the message log. If it is a child address, we
1132 call child_done() to scan the ancestors and mark them complete if this is the
1133 last child to complete. */
1134
1135 address_done(addr, now);
1136 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1137
1138 if (addr->parent == NULL)
059ec3d9
PH
1139 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1140 driver_name, driver_kind);
059ec3d9
PH
1141 else
1142 {
1143 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1144 addr->parent->address, driver_name, driver_kind);
1145 child_done(addr, now);
1146 }
1147
774ef2d7 1148 /* Certificates for logging (via events) */
a7538db1 1149#ifdef SUPPORT_TLS
9d1c15ef
JH
1150 tls_out.ourcert = addr->ourcert;
1151 addr->ourcert = NULL;
1152 tls_out.peercert = addr->peercert;
1153 addr->peercert = NULL;
018058b2 1154
018058b2
JH
1155 tls_out.cipher = addr->cipher;
1156 tls_out.peerdn = addr->peerdn;
1157 tls_out.ocsp = addr->ocsp;
83b27293
JH
1158# ifdef EXPERIMENTAL_DANE
1159 tls_out.dane_verified = testflag(addr, af_dane_verified);
1160# endif
a7538db1 1161#endif
9d1c15ef 1162
817d9f57 1163 delivery_log(LOG_MAIN, addr, logchar, NULL);
9d1c15ef 1164
a7538db1 1165#ifdef SUPPORT_TLS
9d1c15ef
JH
1166 if (tls_out.ourcert)
1167 {
1168 tls_free_cert(tls_out.ourcert);
1169 tls_out.ourcert = NULL;
1170 }
1171 if (tls_out.peercert)
1172 {
1173 tls_free_cert(tls_out.peercert);
1174 tls_out.peercert = NULL;
1175 }
018058b2
JH
1176 tls_out.cipher = NULL;
1177 tls_out.peerdn = NULL;
1178 tls_out.ocsp = OCSP_NOT_REQ;
83b27293
JH
1179# ifdef EXPERIMENTAL_DANE
1180 tls_out.dane_verified = FALSE;
1181# endif
a7538db1 1182#endif
059ec3d9
PH
1183 }
1184
1185
1186/* Soft failure, or local delivery process failed; freezing may be
1187requested. */
1188
1189else if (result == DEFER || result == PANIC)
1190 {
1191 if (result == PANIC) logflags |= LOG_PANIC;
1192
1193 /* This puts them on the chain in reverse order. Do not change this, because
1194 the code for handling retries assumes that the one with the retry
1195 information is last. */
1196
1197 addr->next = addr_defer;
1198 addr_defer = addr;
1199
1200 /* The only currently implemented special action is to freeze the
1201 message. Logging of this is done later, just before the -H file is
1202 updated. */
1203
1204 if (addr->special_action == SPECIAL_FREEZE)
1205 {
1206 deliver_freeze = TRUE;
1207 deliver_frozen_at = time(NULL);
1208 update_spool = TRUE;
1209 }
1210
1211 /* If doing a 2-stage queue run, we skip writing to either the message
1212 log or the main log for SMTP defers. */
1213
1214 if (!queue_2stage || addr->basic_errno != 0)
1215 {
1216 uschar ss[32];
1217
1218 /* For errors of the type "retry time not reached" (also remotes skipped
1219 on queue run), logging is controlled by L_retry_defer. Note that this kind
1220 of error number is negative, and all the retry ones are less than any
1221 others. */
1222
1223 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1224 L_retry_defer : 0;
1225
1226 /* Build up the line that is used for both the message log and the main
1227 log. */
1228
1229 s = reset_point = store_get(size);
e4bdf652
JH
1230
1231 /* Create the address string for logging. Must not do this earlier, because
1232 an OK result may be changed to FAIL when a pipe returns text. */
1233
1234 log_address = string_log_address(addr,
1235 (log_write_selector & L_all_parents) != 0, result == OK);
1236
059ec3d9
PH
1237 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1238
1239 /* Either driver_name contains something and driver_kind contains
1240 " router" or " transport" (note the leading space), or driver_name is
1241 a null string and driver_kind contains "routing" without the leading
1242 space, if all routing has been deferred. When a domain has been held,
1243 so nothing has been done at all, both variables contain null strings. */
1244
1245 if (driver_name == NULL)
1246 {
1247 if (driver_kind != NULL)
1248 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1249 }
1250 else
1251 {
1252 if (driver_kind[1] == 't' && addr->router != NULL)
1253 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1254 Ustrcpy(ss, " ?=");
1255 ss[1] = toupper(driver_kind[1]);
1256 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1257 }
1258
1259 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1260 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1261
1262 if (addr->basic_errno > 0)
1263 s = string_append(s, &size, &ptr, 2, US": ",
1264 US strerror(addr->basic_errno));
1265
c562fd30
JH
1266 if (addr->host_used)
1267 s = string_append(s, &size, &ptr, 5,
1268 US" H=", addr->host_used->name,
1269 US" [", addr->host_used->address, US"]");
1270
059ec3d9
PH
1271 if (addr->message != NULL)
1272 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1273
1274 s[ptr] = 0;
1275
1276 /* Log the deferment in the message log, but don't clutter it
1277 up with retry-time defers after the first delivery attempt. */
1278
1279 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1280 deliver_msglog("%s %s\n", now, s);
1281
1282 /* Write the main log and reset the store */
1283
1284 log_write(use_log_selector, logflags, "== %s", s);
1285 store_reset(reset_point);
1286 }
1287 }
1288
1289
1290/* Hard failure. If there is an address to which an error message can be sent,
1291put this address on the failed list. If not, put it on the deferred list and
1292freeze the mail message for human attention. The latter action can also be
1293explicitly requested by a router or transport. */
1294
1295else
1296 {
1297 /* If this is a delivery error, or a message for which no replies are
1298 wanted, and the message's age is greater than ignore_bounce_errors_after,
1299 force the af_ignore_error flag. This will cause the address to be discarded
1300 later (with a log entry). */
1301
1302 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1303 setflag(addr, af_ignore_error);
1304
1305 /* Freeze the message if requested, or if this is a bounce message (or other
652e1b65
PH
1306 message with null sender) and this address does not have its own errors
1307 address. However, don't freeze if errors are being ignored. The actual code
1308 to ignore occurs later, instead of sending a message. Logging of freezing
1309 occurs later, just before writing the -H file. */
059ec3d9
PH
1310
1311 if (!testflag(addr, af_ignore_error) &&
652e1b65 1312 (addr->special_action == SPECIAL_FREEZE ||
d43cbe25 1313 (sender_address[0] == 0 && addr->prop.errors_address == NULL)
652e1b65 1314 ))
059ec3d9
PH
1315 {
1316 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1317 (sender_local && !local_error_message)?
1318 US" (message created with -f <>)" : US" (delivery error message)";
1319 deliver_freeze = TRUE;
1320 deliver_frozen_at = time(NULL);
1321 update_spool = TRUE;
1322
1323 /* The address is put on the defer rather than the failed queue, because
1324 the message is being retained. */
1325
1326 addr->next = addr_defer;
1327 addr_defer = addr;
1328 }
1329
1330 /* Don't put the address on the nonrecipients tree yet; wait until an
1331 error message has been successfully sent. */
1332
1333 else
1334 {
1335 addr->next = addr_failed;
1336 addr_failed = addr;
1337 }
1338
1339 /* Build up the log line for the message and main logs */
1340
1341 s = reset_point = store_get(size);
e4bdf652
JH
1342
1343 /* Create the address string for logging. Must not do this earlier, because
1344 an OK result may be changed to FAIL when a pipe returns text. */
1345
1346 log_address = string_log_address(addr,
1347 (log_write_selector & L_all_parents) != 0, result == OK);
1348
059ec3d9
PH
1349 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1350
1351 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1352 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1353
1354 /* Return path may not be set if no delivery actually happened */
1355
1356 if (used_return_path != NULL &&
1357 (log_extra_selector & LX_return_path_on_delivery) != 0)
059ec3d9 1358 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
059ec3d9
PH
1359
1360 if (addr->router != NULL)
1361 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1362 if (addr->transport != NULL)
1363 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1364
1365 if (addr->host_used != NULL)
67d81c10
JH
1366 s = d_hostlog(s, &size, &ptr, addr);
1367
a7538db1 1368#ifdef SUPPORT_TLS
67d81c10 1369 s = d_tlslog(s, &size, &ptr, addr);
a7538db1 1370#endif
059ec3d9
PH
1371
1372 if (addr->basic_errno > 0)
1373 s = string_append(s, &size, &ptr, 2, US": ",
1374 US strerror(addr->basic_errno));
1375
1376 if (addr->message != NULL)
1377 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1378
1379 s[ptr] = 0;
1380
1381 /* Do the logging. For the message log, "routing failed" for those cases,
1382 just to make it clearer. */
1383
1384 if (driver_name == NULL)
1385 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1386 else
1387 deliver_msglog("%s %s\n", now, s);
1388
1389 log_write(0, LOG_MAIN, "** %s", s);
14a465c3 1390
774ef2d7
JH
1391#ifdef EXPERIMENTAL_EVENT
1392 msg_event_raise(US"msg:fail:delivery", addr);
14a465c3
JH
1393#endif
1394
059ec3d9
PH
1395 store_reset(reset_point);
1396 }
1397
1398/* Ensure logging is turned on again in all cases */
1399
1400disable_logging = FALSE;
1401}
1402
1403
1404
1405
1406/*************************************************
1407* Address-independent error *
1408*************************************************/
1409
1410/* This function is called when there's an error that is not dependent on a
1411particular address, such as an expansion string failure. It puts the error into
1412all the addresses in a batch, logs the incident on the main and panic logs, and
1413clears the expansions. It is mostly called from local_deliver(), but can be
1414called for a remote delivery via findugid().
1415
1416Arguments:
1417 logit TRUE if (MAIN+PANIC) logging required
1418 addr the first of the chain of addresses
1419 code the error code
1420 format format string for error message, or NULL if already set in addr
1421 ... arguments for the format
1422
1423Returns: nothing
1424*/
1425
1426static void
1427common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1428{
1429address_item *addr2;
1430addr->basic_errno = code;
1431
1432if (format != NULL)
1433 {
1434 va_list ap;
1435 uschar buffer[512];
1436 va_start(ap, format);
1437 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1438 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
81f91683 1439 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
059ec3d9
PH
1440 va_end(ap);
1441 addr->message = string_copy(buffer);
1442 }
1443
1444for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1445 {
1446 addr2->basic_errno = code;
1447 addr2->message = addr->message;
1448 }
1449
1450if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1451deliver_set_expansions(NULL);
1452}
1453
1454
1455
1456
1457/*************************************************
1458* Check a "never users" list *
1459*************************************************/
1460
1461/* This function is called to check whether a uid is on one of the two "never
1462users" lists.
1463
1464Arguments:
1465 uid the uid to be checked
1466 nusers the list to be scanned; the first item in the list is the count
1467
1468Returns: TRUE if the uid is on the list
1469*/
1470
1471static BOOL
1472check_never_users(uid_t uid, uid_t *nusers)
1473{
1474int i;
1475if (nusers == NULL) return FALSE;
1476for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1477return FALSE;
1478}
1479
1480
1481
1482/*************************************************
1483* Find uid and gid for a transport *
1484*************************************************/
1485
1486/* This function is called for both local and remote deliveries, to find the
1487uid/gid under which to run the delivery. The values are taken preferentially
1488from the transport (either explicit or deliver_as_creator), then from the
1489address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1490the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1491panic error is logged, and the function fails (which normally leads to delivery
1492deferral).
1493
1494Arguments:
1495 addr the address (possibly a chain)
1496 tp the transport
1497 uidp pointer to uid field
1498 gidp pointer to gid field
1499 igfp pointer to the use_initgroups field
1500
1501Returns: FALSE if failed - error has been set in address(es)
1502*/
1503
1504static BOOL
1505findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1506 BOOL *igfp)
1507{
1508uschar *nuname = NULL;
1509BOOL gid_set = FALSE;
1510
1511/* Default initgroups flag comes from the transport */
1512
1513*igfp = tp->initgroups;
1514
1515/* First see if there's a gid on the transport, either fixed or expandable.
1516The expanding function always logs failure itself. */
1517
1518if (tp->gid_set)
1519 {
1520 *gidp = tp->gid;
1521 gid_set = TRUE;
1522 }
1523else if (tp->expand_gid != NULL)
1524 {
1525 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1526 &(addr->message))) gid_set = TRUE;
1527 else
1528 {
1529 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1530 return FALSE;
1531 }
1532 }
1533
911f6fde
PH
1534/* If the transport did not set a group, see if the router did. */
1535
1536if (!gid_set && testflag(addr, af_gid_set))
1537 {
1538 *gidp = addr->gid;
1539 gid_set = TRUE;
1540 }
1541
059ec3d9
PH
1542/* Pick up a uid from the transport if one is set. */
1543
1544if (tp->uid_set) *uidp = tp->uid;
1545
1546/* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1547it does not provide a passwd value from which a gid can be taken. */
1548
1549else if (tp->expand_uid != NULL)
1550 {
1551 struct passwd *pw;
1552 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1553 uidp, &(addr->message)))
1554 {
1555 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1556 return FALSE;
1557 }
1558 if (!gid_set && pw != NULL)
1559 {
1560 *gidp = pw->pw_gid;
1561 gid_set = TRUE;
1562 }
1563 }
1564
1565/* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1566
1567else if (tp->deliver_as_creator)
1568 {
1569 *uidp = originator_uid;
1570 if (!gid_set)
1571 {
1572 *gidp = originator_gid;
1573 gid_set = TRUE;
1574 }
1575 }
1576
911f6fde
PH
1577/* Otherwise see if the address specifies the uid and if so, take it and its
1578initgroups flag. */
059ec3d9
PH
1579
1580else if (testflag(addr, af_uid_set))
1581 {
1582 *uidp = addr->uid;
1583 *igfp = testflag(addr, af_initgroups);
059ec3d9
PH
1584 }
1585
1586/* Nothing has specified the uid - default to the Exim user, and group if the
1587gid is not set. */
1588
1589else
1590 {
1591 *uidp = exim_uid;
1592 if (!gid_set)
1593 {
1594 *gidp = exim_gid;
1595 gid_set = TRUE;
1596 }
1597 }
1598
911f6fde
PH
1599/* If no gid is set, it is a disaster. We default to the Exim gid only if
1600defaulting to the Exim uid. In other words, if the configuration has specified
1601a uid, it must also provide a gid. */
059ec3d9
PH
1602
1603if (!gid_set)
1604 {
1605 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1606 "%s transport", tp->name);
1607 return FALSE;
1608 }
1609
1610/* Check that the uid is not on the lists of banned uids that may not be used
1611for delivery processes. */
1612
1613if (check_never_users(*uidp, never_users))
1614 nuname = US"never_users";
1615else if (check_never_users(*uidp, fixed_never_users))
1616 nuname = US"fixed_never_users";
1617
1618if (nuname != NULL)
1619 {
1620 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1621 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1622 return FALSE;
1623 }
1624
1625/* All is well */
1626
1627return TRUE;
1628}
1629
1630
1631
1632
1633/*************************************************
1634* Check the size of a message for a transport *
1635*************************************************/
1636
1637/* Checks that the message isn't too big for the selected transport.
1638This is called only when it is known that the limit is set.
1639
1640Arguments:
1641 tp the transport
1642 addr the (first) address being delivered
1643
1644Returns: OK
1645 DEFER expansion failed or did not yield an integer
1646 FAIL message too big
1647*/
1648
1649int
1650check_message_size(transport_instance *tp, address_item *addr)
1651{
1652int rc = OK;
1653int size_limit;
1654
1655deliver_set_expansions(addr);
d45b1de8 1656size_limit = expand_string_integer(tp->message_size_limit, TRUE);
059ec3d9
PH
1657deliver_set_expansions(NULL);
1658
d45b1de8 1659if (expand_string_message != NULL)
059ec3d9
PH
1660 {
1661 rc = DEFER;
1662 if (size_limit == -1)
1663 addr->message = string_sprintf("failed to expand message_size_limit "
1664 "in %s transport: %s", tp->name, expand_string_message);
1665 else
1666 addr->message = string_sprintf("invalid message_size_limit "
1667 "in %s transport: %s", tp->name, expand_string_message);
1668 }
1669else if (size_limit > 0 && message_size > size_limit)
1670 {
1671 rc = FAIL;
1672 addr->message =
1673 string_sprintf("message is too big (transport limit = %d)",
1674 size_limit);
1675 }
1676
1677return rc;
1678}
1679
1680
1681
1682/*************************************************
1683* Transport-time check for a previous delivery *
1684*************************************************/
1685
1686/* Check that this base address hasn't previously been delivered to its routed
c2c19e9d
PH
1687transport. If it has been delivered, mark it done. The check is necessary at
1688delivery time in order to handle homonymic addresses correctly in cases where
1689the pattern of redirection changes between delivery attempts (so the unique
1690fields change). Non-homonymic previous delivery is detected earlier, at routing
1691time (which saves unnecessary routing).
1692
1693Arguments:
1694 addr the address item
1695 testing TRUE if testing wanted only, without side effects
059ec3d9 1696
059ec3d9
PH
1697Returns: TRUE if previously delivered by the transport
1698*/
1699
1700static BOOL
c2c19e9d 1701previously_transported(address_item *addr, BOOL testing)
059ec3d9
PH
1702{
1703(void)string_format(big_buffer, big_buffer_size, "%s/%s",
1704 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1705
1706if (tree_search(tree_nonrecipients, big_buffer) != 0)
1707 {
1708 DEBUG(D_deliver|D_route|D_transport)
1709 debug_printf("%s was previously delivered (%s transport): discarded\n",
1710 addr->address, addr->transport->name);
c2c19e9d 1711 if (!testing) child_done(addr, tod_stamp(tod_log));
059ec3d9
PH
1712 return TRUE;
1713 }
1714
1715return FALSE;
1716}
1717
1718
1719
064a94c9
PH
1720/******************************************************
1721* Check for a given header in a header string *
1722******************************************************/
1723
1724/* This function is used when generating quota warnings. The configuration may
1725specify any header lines it likes in quota_warn_message. If certain of them are
1726missing, defaults are inserted, so we need to be able to test for the presence
1727of a given header.
1728
1729Arguments:
1730 hdr the required header name
1731 hstring the header string
1732
1733Returns: TRUE the header is in the string
1734 FALSE the header is not in the string
1735*/
1736
1737static BOOL
1738contains_header(uschar *hdr, uschar *hstring)
1739{
1740int len = Ustrlen(hdr);
1741uschar *p = hstring;
1742while (*p != 0)
1743 {
1744 if (strncmpic(p, hdr, len) == 0)
1745 {
1746 p += len;
1747 while (*p == ' ' || *p == '\t') p++;
1748 if (*p == ':') return TRUE;
1749 }
1750 while (*p != 0 && *p != '\n') p++;
1751 if (*p == '\n') p++;
1752 }
1753return FALSE;
1754}
1755
1756
1757
059ec3d9
PH
1758
1759/*************************************************
1760* Perform a local delivery *
1761*************************************************/
1762
1763/* Each local delivery is performed in a separate process which sets its
1764uid and gid as specified. This is a safer way than simply changing and
1765restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1766used safely. From release 4, Exim no longer makes any use of it. Besides, not
1767all systems have seteuid().
1768
1769If the uid/gid are specified in the transport_instance, they are used; the
1770transport initialization must ensure that either both or neither are set.
1771Otherwise, the values associated with the address are used. If neither are set,
1772it is a configuration error.
1773
1774The transport or the address may specify a home directory (transport over-
1775rides), and if they do, this is set as $home. If neither have set a working
1776directory, this value is used for that as well. Otherwise $home is left unset
1777and the cwd is set to "/" - a directory that should be accessible to all users.
1778
1779Using a separate process makes it more complicated to get error information
1780back. We use a pipe to pass the return code and also an error code and error
1781text string back to the parent process.
1782
1783Arguments:
1784 addr points to an address block for this delivery; for "normal" local
1785 deliveries this is the only address to be delivered, but for
1786 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1787 a number of addresses can be handled simultaneously, and in this
1788 case addr will point to a chain of addresses with the same
1789 characteristics.
1790
1791 shadowing TRUE if running a shadow transport; this causes output from pipes
1792 to be ignored.
1793
1794Returns: nothing
1795*/
1796
1797static void
1798deliver_local(address_item *addr, BOOL shadowing)
1799{
1800BOOL use_initgroups;
1801uid_t uid;
1802gid_t gid;
1803int status, len, rc;
1804int pfd[2];
1805pid_t pid;
1806uschar *working_directory;
1807address_item *addr2;
1808transport_instance *tp = addr->transport;
1809
1810/* Set up the return path from the errors or sender address. If the transport
1811has its own return path setting, expand it and replace the existing value. */
1812
d43cbe25
JH
1813if(addr->prop.errors_address != NULL)
1814 return_path = addr->prop.errors_address;
384152a6 1815#ifdef EXPERIMENTAL_SRS
d43cbe25
JH
1816else if(addr->prop.srs_sender != NULL)
1817 return_path = addr->prop.srs_sender;
384152a6
TK
1818#endif
1819else
1820 return_path = sender_address;
059ec3d9
PH
1821
1822if (tp->return_path != NULL)
1823 {
1824 uschar *new_return_path = expand_string(tp->return_path);
1825 if (new_return_path == NULL)
1826 {
1827 if (!expand_string_forcedfail)
1828 {
1829 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1830 US"Failed to expand return path \"%s\" in %s transport: %s",
1831 tp->return_path, tp->name, expand_string_message);
1832 return;
1833 }
1834 }
1835 else return_path = new_return_path;
1836 }
1837
1838/* For local deliveries, one at a time, the value used for logging can just be
1839set directly, once and for all. */
1840
1841used_return_path = return_path;
1842
1843/* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1844gets put into the address(es), and the expansions are unset, so we can just
1845return. */
1846
1847if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1848
5418e93b
PH
1849/* See if either the transport or the address specifies a home directory. A
1850home directory set in the address may already be expanded; a flag is set to
1851indicate that. In other cases we must expand it. */
059ec3d9 1852
5418e93b
PH
1853if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1854 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1855 !testflag(addr, af_home_expanded))) /* not expanded */
059ec3d9
PH
1856 {
1857 uschar *rawhome = deliver_home;
1858 deliver_home = NULL; /* in case it contains $home */
1859 deliver_home = expand_string(rawhome);
1860 if (deliver_home == NULL)
1861 {
1862 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1863 "to expand for %s transport: %s", rawhome, tp->name,
1864 expand_string_message);
1865 return;
1866 }
1867 if (*deliver_home != '/')
1868 {
1869 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1870 "is not absolute for %s transport", deliver_home, tp->name);
1871 return;
1872 }
1873 }
1874
5418e93b
PH
1875/* See if either the transport or the address specifies a current directory,
1876and if so, expand it. If nothing is set, use the home directory, unless it is
1877also unset in which case use "/", which is assumed to be a directory to which
1878all users have access. It is necessary to be in a visible directory for some
1879operating systems when running pipes, as some commands (e.g. "rm" under Solaris
18802.5) require this. */
1881
1882working_directory = (tp->current_dir != NULL)?
1883 tp->current_dir : addr->current_dir;
059ec3d9
PH
1884
1885if (working_directory != NULL)
1886 {
1887 uschar *raw = working_directory;
1888 working_directory = expand_string(raw);
1889 if (working_directory == NULL)
1890 {
1891 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1892 "failed to expand for %s transport: %s", raw, tp->name,
1893 expand_string_message);
1894 return;
1895 }
1896 if (*working_directory != '/')
1897 {
1898 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1899 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1900 return;
1901 }
1902 }
1903else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1904
1905/* If one of the return_output flags is set on the transport, create and open a
1906file in the message log directory for the transport to write its output onto.
1907This is mainly used by pipe transports. The file needs to be unique to the
1908address. This feature is not available for shadow transports. */
1909
1910if (!shadowing && (tp->return_output || tp->return_fail_output ||
1911 tp->log_output || tp->log_fail_output))
1912 {
1913 uschar *error;
1914 addr->return_filename =
1915 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1916 message_id, getpid(), return_count++);
1917 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1918 if (addr->return_file < 0)
1919 {
1920 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1921 "to return message: %s", error, tp->name, strerror(errno));
1922 return;
1923 }
1924 }
1925
1926/* Create the pipe for inter-process communication. */
1927
1928if (pipe(pfd) != 0)
1929 {
1930 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1931 strerror(errno));
1932 return;
1933 }
1934
1935/* Now fork the process to do the real work in the subprocess, but first
1936ensure that all cached resources are freed so that the subprocess starts with
1937a clean slate and doesn't interfere with the parent process. */
1938
1939search_tidyup();
1940
1941if ((pid = fork()) == 0)
1942 {
1943 BOOL replicate = TRUE;
1944
1945 /* Prevent core dumps, as we don't want them in users' home directories.
1946 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1947 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1948 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
a29e5231
PP
1949 complain if the error is "not supported".
1950
1951 There are two scenarios where changing the max limit has an effect. In one,
1952 the user is using a .forward and invoking a command of their choice via pipe;
1953 for these, we do need the max limit to be 0 unless the admin chooses to
1954 permit an increased limit. In the other, the command is invoked directly by
1955 the transport and is under administrator control, thus being able to raise
1956 the limit aids in debugging. So there's no general always-right answer.
1957
1958 Thus we inhibit core-dumps completely but let individual transports, while
1959 still root, re-raise the limits back up to aid debugging. We make the
1960 default be no core-dumps -- few enough people can use core dumps in
1961 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1962 */
059ec3d9 1963
a7538db1 1964#ifdef RLIMIT_CORE
059ec3d9
PH
1965 struct rlimit rl;
1966 rl.rlim_cur = 0;
1967 rl.rlim_max = 0;
1968 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1969 {
a7538db1 1970# ifdef SETRLIMIT_NOT_SUPPORTED
059ec3d9 1971 if (errno != ENOSYS && errno != ENOTSUP)
a7538db1 1972# endif
059ec3d9
PH
1973 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1974 strerror(errno));
1975 }
a7538db1 1976#endif
059ec3d9
PH
1977
1978 /* Reset the random number generator, so different processes don't all
1979 have the same sequence. */
1980
1981 random_seed = 0;
1982
1983 /* If the transport has a setup entry, call this first, while still
1984 privileged. (Appendfile uses this to expand quota, for example, while
1985 able to read private files.) */
1986
1987 if (addr->transport->setup != NULL)
1988 {
929ba01c 1989 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
059ec3d9
PH
1990 &(addr->message)))
1991 {
1992 case DEFER:
1993 addr->transport_return = DEFER;
1994 goto PASS_BACK;
1995
1996 case FAIL:
1997 addr->transport_return = PANIC;
1998 goto PASS_BACK;
1999 }
2000 }
2001
2002 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2003 when the process becomes unprivileged, it won't be able to write to the
2004 process log. SIGHUP is ignored throughout exim, except when it is being
2005 run as a daemon. */
2006
2007 signal(SIGINT, SIG_IGN);
2008 signal(SIGTERM, SIG_IGN);
2009 signal(SIGUSR1, SIG_IGN);
2010
2011 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2012 half - for transports that exec things (e.g. pipe). Then set the required
2013 gid/uid. */
2014
f1e894f3 2015 (void)close(pfd[pipe_read]);
ff790e47 2016 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
059ec3d9
PH
2017 FD_CLOEXEC);
2018 exim_setugid(uid, gid, use_initgroups,
2019 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2020 addr->address, addr->transport->name));
2021
2022 DEBUG(D_deliver)
2023 {
2024 address_item *batched;
2025 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2026 for (batched = addr->next; batched != NULL; batched = batched->next)
2027 debug_printf("additional batched address: %s\n", batched->address);
2028 }
2029
2030 /* Set an appropriate working directory. */
2031
2032 if (Uchdir(working_directory) < 0)
2033 {
2034 addr->transport_return = DEFER;
2035 addr->basic_errno = errno;
2036 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2037 }
2038
2039 /* If successful, call the transport */
2040
2041 else
2042 {
2043 BOOL ok = TRUE;
2044 set_process_info("delivering %s to %s using %s", message_id,
2045 addr->local_part, addr->transport->name);
2046
2a47f028
JH
2047 /* Setting this global in the subprocess means we need never clear it */
2048 transport_name = addr->transport->name;
2049
059ec3d9
PH
2050 /* If a transport filter has been specified, set up its argument list.
2051 Any errors will get put into the address, and FALSE yielded. */
2052
2053 if (addr->transport->filter_command != NULL)
2054 {
2055 ok = transport_set_up_command(&transport_filter_argv,
2056 addr->transport->filter_command,
2057 TRUE, PANIC, addr, US"transport filter", NULL);
2058 transport_filter_timeout = addr->transport->filter_timeout;
2059 }
2060 else transport_filter_argv = NULL;
2061
2062 if (ok)
2063 {
2064 debug_print_string(addr->transport->debug_string);
2065 replicate = !(addr->transport->info->code)(addr->transport, addr);
2066 }
2067 }
2068
2069 /* Pass the results back down the pipe. If necessary, first replicate the
2070 status in the top address to the others in the batch. The label is the
2071 subject of a goto when a call to the transport's setup function fails. We
2072 pass the pointer to the transport back in case it got changed as a result of
2073 file_format in appendfile. */
2074
2075 PASS_BACK:
2076
2077 if (replicate) replicate_status(addr);
2078 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2079 {
2080 int i;
2081 int local_part_length = Ustrlen(addr2->local_part);
2082 uschar *s;
1ac6b2e7 2083 int ret;
059ec3d9 2084
1ac6b2e7
JH
2085 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
2086 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
2087 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
2088 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
2089 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
2090 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
2091 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
2092 sizeof(transport_instance *))) != sizeof(transport_instance *)
059ec3d9
PH
2093
2094 /* For a file delivery, pass back the local part, in case the original
2095 was only part of the final delivery path. This gives more complete
2096 logging. */
2097
1ac6b2e7
JH
2098 || (testflag(addr2, af_file)
2099 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
2100 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2101 )
2102 )
2103 )
2104 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2105 ret == -1 ? strerror(errno) : "short write");
059ec3d9
PH
2106
2107 /* Now any messages */
2108
2109 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2110 {
2111 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
1ac6b2e7
JH
2112 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2113 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2114 )
2115 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2116 ret == -1 ? strerror(errno) : "short write");
059ec3d9
PH
2117 }
2118 }
2119
2120 /* OK, this process is now done. Free any cached resources that it opened,
2121 and close the pipe we were writing down before exiting. */
2122
f1e894f3 2123 (void)close(pfd[pipe_write]);
059ec3d9
PH
2124 search_tidyup();
2125 exit(EXIT_SUCCESS);
2126 }
2127
2128/* Back in the main process: panic if the fork did not succeed. This seems
2129better than returning an error - if forking is failing it is probably best
2130not to try other deliveries for this message. */
2131
2132if (pid < 0)
2133 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2134 addr->address);
2135
2136/* Read the pipe to get the delivery status codes and error messages. Our copy
2137of the writing end must be closed first, as otherwise read() won't return zero
2138on an empty pipe. We check that a status exists for each address before
2139overwriting the address structure. If data is missing, the default DEFER status
2140will remain. Afterwards, close the reading end. */
2141
f1e894f3 2142(void)close(pfd[pipe_write]);
059ec3d9
PH
2143
2144for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2145 {
2146 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2147 if (len > 0)
2148 {
2149 int i;
2150 uschar **sptr;
2151
2152 addr2->transport_return = status;
2153 len = read(pfd[pipe_read], (void *)&transport_count,
2154 sizeof(transport_count));
2155 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2156 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2157 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2158 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2159 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2160 sizeof(transport_instance *));
2161
2162 if (testflag(addr2, af_file))
2163 {
2164 int local_part_length;
2165 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2166 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2167 big_buffer[local_part_length] = 0;
2168 addr2->local_part = string_copy(big_buffer);
2169 }
2170
2171 for (i = 0, sptr = &(addr2->message); i < 2;
2172 i++, sptr = &(addr2->user_message))
2173 {
2174 int message_length;
2175 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2176 if (message_length > 0)
2177 {
2178 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2179 if (len > 0) *sptr = string_copy(big_buffer);
2180 }
2181 }
2182 }
2183
2184 else
2185 {
2186 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2187 "from delivery subprocess", addr2->unique);
2188 break;
2189 }
2190 }
2191
f1e894f3 2192(void)close(pfd[pipe_read]);
059ec3d9
PH
2193
2194/* Unless shadowing, write all successful addresses immediately to the journal
2195file, to ensure they are recorded asap. For homonymic addresses, use the base
2196address plus the transport name. Failure to write the journal is panic-worthy,
2197but don't stop, as it may prove possible subsequently to update the spool file
2198in order to record the delivery. */
2199
2200if (!shadowing)
2201 {
2202 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2203 {
2204 if (addr2->transport_return != OK) continue;
2205
2206 if (testflag(addr2, af_homonym))
2207 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2208 else
2209 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2210
2211 /* In the test harness, wait just a bit to let the subprocess finish off
2212 any debug output etc first. */
2213
2214 if (running_in_test_harness) millisleep(300);
2215
2216 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2217 len = Ustrlen(big_buffer);
2218 if (write(journal_fd, big_buffer, len) != len)
2219 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2220 big_buffer, strerror(errno));
2221 }
2222
2223 /* Ensure the journal file is pushed out to disk. */
2224
54fc8428 2225 if (EXIMfsync(journal_fd) < 0)
059ec3d9
PH
2226 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2227 strerror(errno));
2228 }
2229
2230/* Wait for the process to finish. If it terminates with a non-zero code,
2231freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2232status values of all the addresses as they are. Take care to handle the case
2233when the subprocess doesn't seem to exist. This has been seen on one system
2234when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2235happens, wait() doesn't recognize the termination of child processes. Exim now
2236resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2237
2238while ((rc = wait(&status)) != pid)
2239 {
2240 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2241 {
2242 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2243 addr->transport->driver_name);
2244 status = 0;
2245 break;
2246 }
2247 }
2248
2249if ((status & 0xffff) != 0)
2250 {
2251 int msb = (status >> 8) & 255;
2252 int lsb = status & 255;
2253 int code = (msb == 0)? (lsb & 0x7f) : msb;
2254 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2255 addr->special_action = SPECIAL_FREEZE;
2256 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2257 "status 0x%04x: %s %d",
2258 addr->transport->driver_name,
2259 status,
2260 (msb == 0)? "terminated by signal" : "exit code",
2261 code);
2262 }
2263
2264/* If SPECIAL_WARN is set in the top address, send a warning message. */
2265
2266if (addr->special_action == SPECIAL_WARN &&
2267 addr->transport->warn_message != NULL)
2268 {
2269 int fd;
2270 uschar *warn_message;
2271
2272 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2273
2274 warn_message = expand_string(addr->transport->warn_message);
2275 if (warn_message == NULL)
2276 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2277 "message for %s transport): %s", addr->transport->warn_message,
2278 addr->transport->name, expand_string_message);
2279 else
2280 {
2281 pid_t pid = child_open_exim(&fd);
2282 if (pid > 0)
2283 {
2284 FILE *f = fdopen(fd, "wb");
064a94c9
PH
2285 if (errors_reply_to != NULL &&
2286 !contains_header(US"Reply-To", warn_message))
059ec3d9 2287 fprintf(f, "Reply-To: %s\n", errors_reply_to);
456682f5 2288 fprintf(f, "Auto-Submitted: auto-replied\n");
0e22dfd1 2289 if (!contains_header(US"From", warn_message)) moan_write_from(f);
059ec3d9
PH
2290 fprintf(f, "%s", CS warn_message);
2291
2292 /* Close and wait for child process to complete, without a timeout. */
2293
f1e894f3 2294 (void)fclose(f);
059ec3d9
PH
2295 (void)child_close(pid, 0);
2296 }
2297 }
2298
2299 addr->special_action = SPECIAL_NONE;
2300 }
2301}
2302
2303
2304
2305/*************************************************
2306* Do local deliveries *
2307*************************************************/
2308
2309/* This function processes the list of addresses in addr_local. True local
2310deliveries are always done one address at a time. However, local deliveries can
2311be batched up in some cases. Typically this is when writing batched SMTP output
2312files for use by some external transport mechanism, or when running local
2313deliveries over LMTP.
2314
2315Arguments: None
2316Returns: Nothing
2317*/
2318
2319static void
2320do_local_deliveries(void)
2321{
2322open_db dbblock;
2323open_db *dbm_file = NULL;
2324time_t now = time(NULL);
2325
2326/* Loop until we have exhausted the supply of local deliveries */
2327
2328while (addr_local != NULL)
2329 {
2330 time_t delivery_start;
2331 int deliver_time;
2332 address_item *addr2, *addr3, *nextaddr;
2333 int logflags = LOG_MAIN;
2334 int logchar = dont_deliver? '*' : '=';
2335 transport_instance *tp;
2336
2337 /* Pick the first undelivered address off the chain */
2338
2339 address_item *addr = addr_local;
2340 addr_local = addr->next;
2341 addr->next = NULL;
2342
2343 DEBUG(D_deliver|D_transport)
2344 debug_printf("--------> %s <--------\n", addr->address);
2345
2346 /* An internal disaster if there is no transport. Should not occur! */
2347
2348 if ((tp = addr->transport) == NULL)
2349 {
2350 logflags |= LOG_PANIC;
2351 disable_logging = FALSE; /* Jic */
2352 addr->message =
2353 (addr->router != NULL)?
2354 string_sprintf("No transport set by %s router", addr->router->name)
2355 :
2356 string_sprintf("No transport set by system filter");
2357 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2358 continue;
2359 }
2360
2361 /* Check that this base address hasn't previously been delivered to this
2362 transport. The check is necessary at this point to handle homonymic addresses
2363 correctly in cases where the pattern of redirection changes between delivery
2364 attempts. Non-homonymic previous delivery is detected earlier, at routing
2365 time. */
2366
c2c19e9d 2367 if (previously_transported(addr, FALSE)) continue;
059ec3d9
PH
2368
2369 /* There are weird cases where logging is disabled */
2370
2371 disable_logging = tp->disable_logging;
2372
f7fd3850
PH
2373 /* Check for batched addresses and possible amalgamation. Skip all the work
2374 if either batch_max <= 1 or there aren't any other addresses for local
2375 delivery. */
059ec3d9 2376
f7fd3850 2377 if (tp->batch_max > 1 && addr_local != NULL)
059ec3d9
PH
2378 {
2379 int batch_count = 1;
2380 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
f7fd3850
PH
2381 BOOL uses_lp = (testflag(addr, af_pfr) &&
2382 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2383 readconf_depends((driver_instance *)tp, US"local_part");
059ec3d9
PH
2384 uschar *batch_id = NULL;
2385 address_item **anchor = &addr_local;
2386 address_item *last = addr;
2387 address_item *next;
2388
2389 /* Expand the batch_id string for comparison with other addresses.
2390 Expansion failure suppresses batching. */
2391
2392 if (tp->batch_id != NULL)
2393 {
2394 deliver_set_expansions(addr);
2395 batch_id = expand_string(tp->batch_id);
2396 deliver_set_expansions(NULL);
2397 if (batch_id == NULL)
2398 {
2399 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2400 "in %s transport (%s): %s", tp->name, addr->address,
2401 expand_string_message);
2402 batch_count = tp->batch_max;
2403 }
2404 }
2405
2406 /* Until we reach the batch_max limit, pick off addresses which have the
2407 same characteristics. These are:
2408
2409 same transport
7816e254 2410 not previously delivered (see comment about 50 lines above)
059ec3d9 2411 same local part if the transport's configuration contains $local_part
f7fd3850 2412 or if this is a file or pipe delivery from a redirection
059ec3d9
PH
2413 same domain if the transport's configuration contains $domain
2414 same errors address
2415 same additional headers
2416 same headers to be removed
2417 same uid/gid for running the transport
2418 same first host if a host list is set
2419 */
2420
2421 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2422 {
2423 BOOL ok =
2424 tp == next->transport &&
c2c19e9d 2425 !previously_transported(next, TRUE) &&
f7fd3850 2426 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
059ec3d9
PH
2427 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2428 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
d43cbe25
JH
2429 same_strings(next->prop.errors_address, addr->prop.errors_address) &&
2430 same_headers(next->prop.extra_headers, addr->prop.extra_headers) &&
2431 same_strings(next->prop.remove_headers, addr->prop.remove_headers) &&
059ec3d9
PH
2432 same_ugid(tp, addr, next) &&
2433 ((addr->host_list == NULL && next->host_list == NULL) ||
2434 (addr->host_list != NULL && next->host_list != NULL &&
2435 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2436
2437 /* If the transport has a batch_id setting, batch_id will be non-NULL
2438 from the expansion outside the loop. Expand for this address and compare.
2439 Expansion failure makes this address ineligible for batching. */
2440
2441 if (ok && batch_id != NULL)
2442 {
2443 uschar *bid;
2444 address_item *save_nextnext = next->next;
2445 next->next = NULL; /* Expansion for a single address */
2446 deliver_set_expansions(next);
2447 next->next = save_nextnext;
2448 bid = expand_string(tp->batch_id);
2449 deliver_set_expansions(NULL);
2450 if (bid == NULL)
2451 {
2452 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2453 "in %s transport (%s): %s", tp->name, next->address,
2454 expand_string_message);
2455 ok = FALSE;
2456 }
2457 else ok = (Ustrcmp(batch_id, bid) == 0);
2458 }
2459
2460 /* Take address into batch if OK. */
2461
2462 if (ok)
2463 {
2464 *anchor = next->next; /* Include the address */
2465 next->next = NULL;
2466 last->next = next;
2467 last = next;
2468 batch_count++;
2469 }
2470 else anchor = &(next->next); /* Skip the address */
2471 }
2472 }
2473
2474 /* We now have one or more addresses that can be delivered in a batch. Check
2475 whether the transport is prepared to accept a message of this size. If not,
2476 fail them all forthwith. If the expansion fails, or does not yield an
2477 integer, defer delivery. */
2478
2479 if (tp->message_size_limit != NULL)
2480 {
2481 int rc = check_message_size(tp, addr);
2482 if (rc != OK)
2483 {
2484 replicate_status(addr);
2485 while (addr != NULL)
2486 {
2487 addr2 = addr->next;
2488 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2489 addr = addr2;
2490 }
2491 continue; /* With next batch of addresses */
2492 }
2493 }
2494
2495 /* If we are not running the queue, or if forcing, all deliveries will be
2496 attempted. Otherwise, we must respect the retry times for each address. Even
2497 when not doing this, we need to set up the retry key string, and determine
2498 whether a retry record exists, because after a successful delivery, a delete
2499 retry item must be set up. Keep the retry database open only for the duration
2500 of these checks, rather than for all local deliveries, because some local
2501 deliveries (e.g. to pipes) can take a substantial time. */
2502
2503 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2504 if (dbm_file == NULL)
2505 {
2506 DEBUG(D_deliver|D_retry|D_hints_lookup)
2507 debug_printf("no retry data available\n");
2508 }
2509
2510 addr2 = addr;
2511 addr3 = NULL;
2512 while (addr2 != NULL)
2513 {
2514 BOOL ok = TRUE; /* to deliver this address */
2515 uschar *retry_key;
2516
2517 /* Set up the retry key to include the domain or not, and change its
2518 leading character from "R" to "T". Must make a copy before doing this,
2519 because the old key may be pointed to from a "delete" retry item after
2520 a routing delay. */
2521
2522 retry_key = string_copy(
2523 (tp->retry_use_local_part)? addr2->address_retry_key :
2524 addr2->domain_retry_key);
2525 *retry_key = 'T';
2526
2527 /* Inspect the retry data. If there is no hints file, delivery happens. */
2528
2529 if (dbm_file != NULL)
2530 {
2531 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2532
2533 /* If there is no retry record, delivery happens. If there is,
2534 remember it exists so it can be deleted after a successful delivery. */
2535
2536 if (retry_record != NULL)
2537 {
2538 setflag(addr2, af_lt_retry_exists);
2539
2540 /* A retry record exists for this address. If queue running and not
2541 forcing, inspect its contents. If the record is too old, or if its
2542 retry time has come, or if it has passed its cutoff time, delivery
2543 will go ahead. */
2544
2545 DEBUG(D_retry)
2546 {
ea49d0e1
PH
2547 debug_printf("retry record exists: age=%s ",
2548 readconf_printtime(now - retry_record->time_stamp));
2549 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2550 debug_printf(" time to retry = %s expired = %d\n",
2551 readconf_printtime(retry_record->next_try - now),
2552 retry_record->expired);
059ec3d9
PH
2553 }
2554
2555 if (queue_running && !deliver_force)
2556 {
2557 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2558 (now >= retry_record->next_try) ||
2559 retry_record->expired;
2560
2561 /* If we haven't reached the retry time, there is one more check
1ddeb334 2562 to do, which is for the ultimate address timeout. */
059ec3d9
PH
2563
2564 if (!ok)
ba9af0af
TF
2565 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2566 retry_record, now);
059ec3d9
PH
2567 }
2568 }
2569 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2570 }
2571
2572 /* This address is to be delivered. Leave it on the chain. */
2573
2574 if (ok)
2575 {
2576 addr3 = addr2;
2577 addr2 = addr2->next;
2578 }
2579
2580 /* This address is to be deferred. Take it out of the chain, and
2581 post-process it as complete. Must take it out of the chain first,
2582 because post processing puts it on another chain. */
2583
2584 else
2585 {
2586 address_item *this = addr2;
2587 this->message = US"Retry time not yet reached";
2588 this->basic_errno = ERRNO_LRETRY;
2589 if (addr3 == NULL) addr2 = addr = addr2->next;
2590 else addr2 = addr3->next = addr2->next;
2591 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2592 }
2593 }
2594
2595 if (dbm_file != NULL) dbfn_close(dbm_file);
2596
2597 /* If there are no addresses left on the chain, they all deferred. Loop
2598 for the next set of addresses. */
2599
2600 if (addr == NULL) continue;
2601
2602 /* So, finally, we do have some addresses that can be passed to the
2603 transport. Before doing so, set up variables that are relevant to a
2604 single delivery. */
2605
2606 deliver_set_expansions(addr);
2607 delivery_start = time(NULL);
2608 deliver_local(addr, FALSE);
2609 deliver_time = (int)(time(NULL) - delivery_start);
2610
2611 /* If a shadow transport (which must perforce be another local transport), is
2612 defined, and its condition is met, we must pass the message to the shadow
2613 too, but only those addresses that succeeded. We do this by making a new
2614 chain of addresses - also to keep the original chain uncontaminated. We must
2615 use a chain rather than doing it one by one, because the shadow transport may
2616 batch.
2617
2618 NOTE: if the condition fails because of a lookup defer, there is nothing we
2619 can do! */
2620
2621 if (tp->shadow != NULL &&
2622 (tp->shadow_condition == NULL ||
2623 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2624 {
2625 transport_instance *stp;
2626 address_item *shadow_addr = NULL;
2627 address_item **last = &shadow_addr;
2628
2629 for (stp = transports; stp != NULL; stp = stp->next)
2630 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2631
2632 if (stp == NULL)
2633 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2634 tp->shadow);
2635
2636 /* Pick off the addresses that have succeeded, and make clones. Put into
2637 the shadow_message field a pointer to the shadow_message field of the real
2638 address. */
2639
2640 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2641 {
2642 if (addr2->transport_return != OK) continue;
2643 addr3 = store_get(sizeof(address_item));
2644 *addr3 = *addr2;
2645 addr3->next = NULL;
2646 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2647 addr3->transport = stp;
2648 addr3->transport_return = DEFER;
2649 addr3->return_filename = NULL;
2650 addr3->return_file = -1;
2651 *last = addr3;
2652 last = &(addr3->next);
2653 }
2654
2655 /* If we found any addresses to shadow, run the delivery, and stick any
2656 message back into the shadow_message field in the original. */
2657
2658 if (shadow_addr != NULL)
2659 {
2660 int save_count = transport_count;
2661
2662 DEBUG(D_deliver|D_transport)
2663 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2664 deliver_local(shadow_addr, TRUE);
2665
2666 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2667 {
2668 int sresult = shadow_addr->transport_return;
2669 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2670 string_sprintf(" ST=%s", stp->name) :
2671 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2672 (shadow_addr->basic_errno <= 0)?
2673 US"" : US strerror(shadow_addr->basic_errno),
2674 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2675 US"" : US": ",
2676 (shadow_addr->message != NULL)? shadow_addr->message :
2677 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2678
2679 DEBUG(D_deliver|D_transport)
2680 debug_printf("%s shadow transport returned %s for %s\n",
2681 stp->name,
2682 (sresult == OK)? "OK" :
2683 (sresult == DEFER)? "DEFER" :
2684 (sresult == FAIL)? "FAIL" :
2685 (sresult == PANIC)? "PANIC" : "?",
2686 shadow_addr->address);
2687 }
2688
2689 DEBUG(D_deliver|D_transport)
2690 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2691
2692 transport_count = save_count; /* Restore original transport count */
2693 }
2694 }
2695
2696 /* Cancel the expansions that were set up for the delivery. */
2697
2698 deliver_set_expansions(NULL);
2699
2700 /* Now we can process the results of the real transport. We must take each
2701 address off the chain first, because post_process_one() puts it on another
2702 chain. */
2703
2704 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2705 {
2706 int result = addr2->transport_return;
2707 nextaddr = addr2->next;
2708
2709 DEBUG(D_deliver|D_transport)
2710 debug_printf("%s transport returned %s for %s\n",
2711 tp->name,
2712 (result == OK)? "OK" :
2713 (result == DEFER)? "DEFER" :
2714 (result == FAIL)? "FAIL" :
2715 (result == PANIC)? "PANIC" : "?",
2716 addr2->address);
2717
2718 /* If there is a retry_record, or if delivery is deferred, build a retry
2719 item for setting a new retry time or deleting the old retry record from
2720 the database. These items are handled all together after all addresses
2721 have been handled (so the database is open just for a short time for
2722 updating). */
2723
2724 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2725 {
2726 int flags = (result == DEFER)? 0 : rf_delete;
2727 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2728 addr2->address_retry_key : addr2->domain_retry_key);
2729 *retry_key = 'T';
2730 retry_add_item(addr2, retry_key, flags);
2731 }
2732
2733 /* Done with this address */
2734
2735 if (result == OK) addr2->more_errno = deliver_time;
2736 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2737
2738 /* If a pipe delivery generated text to be sent back, the result may be
2739 changed to FAIL, and we must copy this for subsequent addresses in the
2740 batch. */
2741
2742 if (addr2->transport_return != result)
2743 {
2744 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2745 {
2746 addr3->transport_return = addr2->transport_return;
2747 addr3->basic_errno = addr2->basic_errno;
2748 addr3->message = addr2->message;
2749 }
2750 result = addr2->transport_return;
2751 }
2752
2753 /* Whether or not the result was changed to FAIL, we need to copy the
2754 return_file value from the first address into all the addresses of the
2755 batch, so they are all listed in the error message. */
2756
2757 addr2->return_file = addr->return_file;
2758
2759 /* Change log character for recording successful deliveries. */
2760
2761 if (result == OK) logchar = '-';
2762 }
2763 } /* Loop back for next batch of addresses */
2764}
2765
2766
2767
2768
2769/*************************************************
2770* Sort remote deliveries *
2771*************************************************/
2772
2773/* This function is called if remote_sort_domains is set. It arranges that the
2774chain of addresses for remote deliveries is ordered according to the strings
2775specified. Try to make this shuffling reasonably efficient by handling
2776sequences of addresses rather than just single ones.
2777
2778Arguments: None
2779Returns: Nothing
2780*/
2781
2782static void
2783sort_remote_deliveries(void)
2784{
2785int sep = 0;
2786address_item **aptr = &addr_remote;
55414b25 2787const uschar *listptr = remote_sort_domains;
059ec3d9
PH
2788uschar *pattern;
2789uschar patbuf[256];
2790
2791while (*aptr != NULL &&
2792 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2793 != NULL)
2794 {
2795 address_item *moved = NULL;
2796 address_item **bptr = &moved;
2797
2798 while (*aptr != NULL)
2799 {
2800 address_item **next;
2801 deliver_domain = (*aptr)->domain; /* set $domain */
55414b25 2802 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
059ec3d9
PH
2803 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2804 {
2805 aptr = &((*aptr)->next);
2806 continue;
2807 }
2808
2809 next = &((*aptr)->next);
2810 while (*next != NULL &&
2811 (deliver_domain = (*next)->domain, /* Set $domain */
55414b25 2812 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
059ec3d9
PH
2813 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2814 next = &((*next)->next);
2815
2816 /* If the batch of non-matchers is at the end, add on any that were
2817 extracted further up the chain, and end this iteration. Otherwise,
2818 extract them from the chain and hang on the moved chain. */
2819
2820 if (*next == NULL)
2821 {
2822 *next = moved;
2823 break;
2824 }
2825
2826 *bptr = *aptr;
2827 *aptr = *next;
2828 *next = NULL;
2829 bptr = next;
2830 aptr = &((*aptr)->next);
2831 }
2832
2833 /* If the loop ended because the final address matched, *aptr will
2834 be NULL. Add on to the end any extracted non-matching addresses. If
2835 *aptr is not NULL, the loop ended via "break" when *next is null, that
2836 is, there was a string of non-matching addresses at the end. In this
2837 case the extracted addresses have already been added on the end. */
2838
2839 if (*aptr == NULL) *aptr = moved;
2840 }
2841
2842DEBUG(D_deliver)
2843 {
2844 address_item *addr;
2845 debug_printf("remote addresses after sorting:\n");
2846 for (addr = addr_remote; addr != NULL; addr = addr->next)
2847 debug_printf(" %s\n", addr->address);
2848 }
2849}
2850
2851
2852
2853/*************************************************
2854* Read from pipe for remote delivery subprocess *
2855*************************************************/
2856
2857/* This function is called when the subprocess is complete, but can also be
2858called before it is complete, in order to empty a pipe that is full (to prevent
2859deadlock). It must therefore keep track of its progress in the parlist data
2860block.
2861
2862We read the pipe to get the delivery status codes and a possible error message
2863for each address, optionally preceded by unusability data for the hosts and
2864also by optional retry data.
2865
2866Read in large chunks into the big buffer and then scan through, interpreting
2867the data therein. In most cases, only a single read will be necessary. No
1c5466b9
PH
2868individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2869that we read the next chunk when there is less than 2500 bytes left in the
2870non-final chunk, we can assume each item is complete in the buffer before
2871handling it. Each item is written using a single write(), which is atomic for
2872small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2873often bigger) so even if we are reading while the subprocess is still going, we
2874should never have only a partial item in the buffer.
059ec3d9
PH
2875
2876Argument:
2877 poffset the offset of the parlist item
2878 eop TRUE if the process has completed
2879
2880Returns: TRUE if the terminating 'Z' item has been read,
2881 or there has been a disaster (i.e. no more data needed);
2882 FALSE otherwise
2883*/
2884
2885static BOOL
2886par_read_pipe(int poffset, BOOL eop)
2887{
2888host_item *h;
2889pardata *p = parlist + poffset;
2890address_item *addrlist = p->addrlist;
2891address_item *addr = p->addr;
2892pid_t pid = p->pid;
2893int fd = p->fd;
2894uschar *endptr = big_buffer;
2895uschar *ptr = endptr;
2896uschar *msg = p->msg;
2897BOOL done = p->done;
2898BOOL unfinished = TRUE;
bd21a787
WB
2899/* minimum size to read is header size including id, subid and length */
2900int required = PIPE_HEADER_SIZE;
059ec3d9
PH
2901
2902/* Loop through all items, reading from the pipe when necessary. The pipe
2903is set up to be non-blocking, but there are two different Unix mechanisms in
2904use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2905and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2906which returns 0 for both end of file and no more data. We distinguish the
2907two cases by taking 0 as end of file only when we know the process has
2908completed.
2909
2910Each separate item is written to the pipe in a single write(), and as they are
2911all short items, the writes will all be atomic and we should never find
8e669ac1
PH
2912ourselves in the position of having read an incomplete item. "Short" in this
2913case can mean up to about 1K in the case when there is a long error message
1c5466b9 2914associated with an address. */
059ec3d9
PH
2915
2916DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2917 (int)p->pid, eop? "ended" : "not ended");
2918
2919while (!done)
2920 {
2921 retry_item *r, **rp;
2922 int remaining = endptr - ptr;
bd21a787
WB
2923 uschar header[PIPE_HEADER_SIZE + 1];
2924 uschar id, subid;
2925 uschar *endc;
059ec3d9
PH
2926
2927 /* Read (first time) or top up the chars in the buffer if necessary.
2928 There will be only one read if we get all the available data (i.e. don't
2929 fill the buffer completely). */
2930
bd21a787 2931 if (remaining < required && unfinished)
059ec3d9
PH
2932 {
2933 int len;
2934 int available = big_buffer_size - remaining;
2935
2936 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2937
2938 ptr = big_buffer;
2939 endptr = big_buffer + remaining;
2940 len = read(fd, endptr, available);
2941
2942 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2943
2944 /* If the result is EAGAIN and the process is not complete, just
2945 stop reading any more and process what we have already. */
2946
2947 if (len < 0)
2948 {
2949 if (!eop && errno == EAGAIN) len = 0; else
2950 {
2951 msg = string_sprintf("failed to read pipe from transport process "
2952 "%d for transport %s: %s", pid, addr->transport->driver_name,
2953 strerror(errno));
2954 break;
2955 }
2956 }
2957
2958 /* If the length is zero (eof or no-more-data), just process what we
2959 already have. Note that if the process is still running and we have
2960 read all the data in the pipe (but less that "available") then we
2961 won't read any more, as "unfinished" will get set FALSE. */
2962
2963 endptr += len;
bd21a787 2964 remaining += len;
059ec3d9
PH
2965 unfinished = len == available;
2966 }
2967
2968 /* If we are at the end of the available data, exit the loop. */
059ec3d9
PH
2969 if (ptr >= endptr) break;
2970
bd21a787
WB
2971 /* copy and read header */
2972 memcpy(header, ptr, PIPE_HEADER_SIZE);
2973 header[PIPE_HEADER_SIZE] = '\0';
2974 id = header[0];
2975 subid = header[1];
2976 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
2977 if (*endc)
2978 {
2979 msg = string_sprintf("failed to read pipe from transport process "
2980 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
2981 done = TRUE;
2982 break;
2983 }
2984
2985 DEBUG(D_deliver)
2986 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
2987 id, subid, header+2, required, remaining, unfinished);
2988
2989 /* is there room for the dataset we want to read ? */
2990 if (required > big_buffer_size - PIPE_HEADER_SIZE)
2991 {
2992 msg = string_sprintf("failed to read pipe from transport process "
2993 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
2994 required, big_buffer_size - PIPE_HEADER_SIZE);
2995 done = TRUE;
2996 break;
2997 }
2998
2999 /* we wrote all datasets with atomic write() calls
3000 remaining < required only happens if big_buffer was too small
3001 to get all available data from pipe. unfinished has to be true
3002 as well. */
3003 if (remaining < required)
8fa0a4d4 3004 {
bd21a787
WB
3005 if (unfinished)
3006 continue;
8fa0a4d4
JH
3007 msg = string_sprintf("failed to read pipe from transport process "
3008 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3009 pid, addr->transport->driver_name, required, remaining);
3010 done = TRUE;
3011 break;
3012 }
bd21a787
WB
3013
3014 /* step behind the header */
3015 ptr += PIPE_HEADER_SIZE;
3016
059ec3d9
PH
3017 /* Handle each possible type of item, assuming the complete item is
3018 available in store. */
3019
bd21a787 3020 switch (id)
059ec3d9
PH
3021 {
3022 /* Host items exist only if any hosts were marked unusable. Match
3023 up by checking the IP address. */
3024
3025 case 'H':
3026 for (h = addrlist->host_list; h != NULL; h = h->next)
3027 {
3028 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
3029 h->status = ptr[0];
3030 h->why = ptr[1];
3031 }
3032 ptr += 2;
3033 while (*ptr++);
3034 break;
3035
3036 /* Retry items are sent in a preceding R item for each address. This is
3037 kept separate to keep each message short enough to guarantee it won't
3038 be split in the pipe. Hopefully, in the majority of cases, there won't in
3039 fact be any retry items at all.
3040
3041 The complete set of retry items might include an item to delete a
3042 routing retry if there was a previous routing delay. However, routing
3043 retries are also used when a remote transport identifies an address error.
3044 In that case, there may also be an "add" item for the same key. Arrange
3045 that a "delete" item is dropped in favour of an "add" item. */
3046
3047 case 'R':
3048 if (addr == NULL) goto ADDR_MISMATCH;
3049
3050 DEBUG(D_deliver|D_retry)
3051 debug_printf("reading retry information for %s from subprocess\n",
3052 ptr+1);
3053
3054 /* Cut out any "delete" items on the list. */
3055
3056 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
3057 {
3058 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3059 {
3060 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3061 *rp = r->next; /* Excise a delete item */
3062 DEBUG(D_deliver|D_retry)
3063 debug_printf(" existing delete item dropped\n");
3064 }
3065 }
3066
3067 /* We want to add a delete item only if there is no non-delete item;
3068 however we still have to step ptr through the data. */
3069
3070 if (r == NULL || (*ptr & rf_delete) == 0)
3071 {
3072 r = store_get(sizeof(retry_item));
3073 r->next = addr->retries;
3074 addr->retries = r;
3075 r->flags = *ptr++;
3076 r->key = string_copy(ptr);
3077 while (*ptr++);
3078 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3079 ptr += sizeof(r->basic_errno);
3080 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3081 ptr += sizeof(r->more_errno);
3082 r->message = (*ptr)? string_copy(ptr) : NULL;
3083 DEBUG(D_deliver|D_retry)
3084 debug_printf(" added %s item\n",
3085 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3086 }
3087
3088 else
3089 {
3090 DEBUG(D_deliver|D_retry)
3091 debug_printf(" delete item not added: non-delete item exists\n");
3092 ptr++;
3093 while(*ptr++);
3094 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3095 }
3096
3097 while(*ptr++);
3098 break;
3099
3100 /* Put the amount of data written into the parlist block */
3101
3102 case 'S':
3103 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3104 ptr += sizeof(transport_count);
3105 break;
3106
3107 /* Address items are in the order of items on the address chain. We
3108 remember the current address value in case this function is called
3109 several times to empty the pipe in stages. Information about delivery
3110 over TLS is sent in a preceding X item for each address. We don't put
3111 it in with the other info, in order to keep each message short enough to
3112 guarantee it won't be split in the pipe. */
3113
a7538db1 3114#ifdef SUPPORT_TLS
059ec3d9 3115 case 'X':
9d1c15ef 3116 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
bd21a787 3117 switch (subid)
9d1c15ef
JH
3118 {
3119 case '1':
3120 addr->cipher = NULL;
3121 addr->peerdn = NULL;
3122
3123 if (*ptr)
3124 addr->cipher = string_copy(ptr);
3125 while (*ptr++);
3126 if (*ptr)
9d1c15ef 3127 addr->peerdn = string_copy(ptr);
9d1c15ef
JH
3128 break;
3129
3130 case '2':
3131 addr->peercert = NULL;
3132 if (*ptr)
3133 (void) tls_import_cert(ptr, &addr->peercert);
3134 break;
3135
3136 case '3':
3137 addr->ourcert = NULL;
3138 if (*ptr)
3139 (void) tls_import_cert(ptr, &addr->ourcert);
3140 break;
018058b2 3141
a7538db1 3142# ifndef DISABLE_OCSP
018058b2
JH
3143 case '4':
3144 addr->ocsp = OCSP_NOT_REQ;
3145 if (*ptr)
3146 addr->ocsp = *ptr - '0';
3147 break;
a7538db1 3148# endif
9d1c15ef 3149 }
059ec3d9
PH
3150 while (*ptr++);
3151 break;
a7538db1 3152#endif /*SUPPORT_TLS*/
059ec3d9 3153
6f123593 3154 case 'C': /* client authenticator information */
bd21a787 3155 switch (subid)
9d1c15ef
JH
3156 {
3157 case '1':
3158 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3159 break;
3160 case '2':
3161 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3162 break;
3163 case '3':
3164 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3165 break;
3166 }
6f123593
JH
3167 while (*ptr++);
3168 break;
3169
8ccd00b1 3170#ifndef DISABLE_PRDR
fd98a5c6 3171 case 'P':
8ccd00b1
JH
3172 addr->flags |= af_prdr_used;
3173 break;
fd98a5c6
JH
3174#endif
3175
6c1c3d1d 3176 case 'D':
bd21a787 3177 if (addr == NULL) goto ADDR_MISMATCH;
6c1c3d1d
WB
3178 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3179 ptr += sizeof(addr->dsn_aware);
3180 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3181 break;
6c1c3d1d 3182
059ec3d9
PH
3183 case 'A':
3184 if (addr == NULL)
3185 {
3186 ADDR_MISMATCH:
3187 msg = string_sprintf("address count mismatch for data read from pipe "
3188 "for transport process %d for transport %s", pid,
3189 addrlist->transport->driver_name);
3190 done = TRUE;
3191 break;
3192 }
3193
3194 addr->transport_return = *ptr++;
3195 addr->special_action = *ptr++;
3196 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3197 ptr += sizeof(addr->basic_errno);
3198 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3199 ptr += sizeof(addr->more_errno);
3200 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3201 ptr += sizeof(addr->flags);
3202 addr->message = (*ptr)? string_copy(ptr) : NULL;
3203 while(*ptr++);
3204 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3205 while(*ptr++);
3206
783b385f 3207 /* Always two strings for host information, followed by the port number and DNSSEC mark */
059ec3d9
PH
3208
3209 if (*ptr != 0)
3210 {
3211 h = store_get(sizeof(host_item));
3212 h->name = string_copy(ptr);
3213 while (*ptr++);
3214 h->address = string_copy(ptr);
3215 while(*ptr++);
3216 memcpy(&(h->port), ptr, sizeof(h->port));
3217 ptr += sizeof(h->port);
783b385f
JH
3218 h->dnssec = *ptr == '2' ? DS_YES
3219 : *ptr == '1' ? DS_NO
3220 : DS_UNK;
3221 ptr++;
059ec3d9
PH
3222 addr->host_used = h;
3223 }
3224 else ptr++;
3225
3226 /* Finished with this address */
3227
3228 addr = addr->next;
3229 break;
3230
aeaf5db3
JH
3231 /* Local interface address/port */
3232 case 'I':
3233 if (*ptr) sending_ip_address = string_copy(ptr);
3234 while (*ptr++) ;
93a6fce2 3235 if (*ptr) sending_port = atoi(CS ptr);
aeaf5db3
JH
3236 while (*ptr++) ;
3237 break;
3238
059ec3d9
PH
3239 /* Z marks the logical end of the data. It is followed by '0' if
3240 continue_transport was NULL at the end of transporting, otherwise '1'.
3241 We need to know when it becomes NULL during a delivery down a passed SMTP
3242 channel so that we don't try to pass anything more down it. Of course, for
3243 most normal messages it will remain NULL all the time. */
3244
3245 case 'Z':
3246 if (*ptr == '0')
3247 {
3248 continue_transport = NULL;
3249 continue_hostname = NULL;
3250 }
3251 done = TRUE;
bd21a787 3252 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
059ec3d9
PH
3253 break;
3254
3255 /* Anything else is a disaster. */
3256
3257 default:
3258 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3259 "process %d for transport %s", ptr[-1], pid,
3260 addr->transport->driver_name);
3261 done = TRUE;
3262 break;
3263 }
3264 }
3265
3266/* The done flag is inspected externally, to determine whether or not to
3267call the function again when the process finishes. */
3268
3269p->done = done;
3270
3271/* If the process hadn't finished, and we haven't seen the end of the data
3272or suffered a disaster, update the rest of the state, and return FALSE to
3273indicate "not finished". */
3274
3275if (!eop && !done)
3276 {
3277 p->addr = addr;
3278 p->msg = msg;
3279 return FALSE;
3280 }
3281
3282/* Close our end of the pipe, to prevent deadlock if the far end is still
3283pushing stuff into it. */
3284
f1e894f3 3285(void)close(fd);
059ec3d9
PH
3286p->fd = -1;
3287
3288/* If we have finished without error, but haven't had data for every address,
3289something is wrong. */
3290
3291if (msg == NULL && addr != NULL)
3292 msg = string_sprintf("insufficient address data read from pipe "
3293 "for transport process %d for transport %s", pid,
3294 addr->transport->driver_name);
3295
3296/* If an error message is set, something has gone wrong in getting back
3297the delivery data. Put the message into each address and freeze it. */
3298
3299if (msg != NULL)
3300 {
3301 for (addr = addrlist; addr != NULL; addr = addr->next)
3302 {
3303 addr->transport_return = DEFER;
3304 addr->special_action = SPECIAL_FREEZE;
3305 addr->message = msg;
3306 }
3307 }
3308
3309/* Return TRUE to indicate we have got all we need from this process, even
3310if it hasn't actually finished yet. */
3311
3312return TRUE;
3313}
3314
3315
3316
3317/*************************************************
3318* Post-process a set of remote addresses *
3319*************************************************/
3320
3321/* Do what has to be done immediately after a remote delivery for each set of
3322addresses, then re-write the spool if necessary. Note that post_process_one
3323puts the address on an appropriate queue; hence we must fish off the next
3324one first. This function is also called if there is a problem with setting
3325up a subprocess to do a remote delivery in parallel. In this case, the final
3326argument contains a message, and the action must be forced to DEFER.
3327
3328Argument:
3329 addr pointer to chain of address items
3330 logflags flags for logging
3331 msg NULL for normal cases; -> error message for unexpected problems
3332 fallback TRUE if processing fallback hosts
3333
3334Returns: nothing
3335*/
3336
3337static void
3338remote_post_process(address_item *addr, int logflags, uschar *msg,
3339 BOOL fallback)
3340{
3341host_item *h;
3342
3343/* If any host addresses were found to be unusable, add them to the unusable
3344tree so that subsequent deliveries don't try them. */
3345
3346for (h = addr->host_list; h != NULL; h = h->next)
3347 {
3348 if (h->address == NULL) continue;
3349 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3350 }
3351
3352/* Now handle each address on the chain. The transport has placed '=' or '-'
3353into the special_action field for each successful delivery. */
3354
3355while (addr != NULL)
3356 {
3357 address_item *next = addr->next;
3358
3359 /* If msg == NULL (normal processing) and the result is DEFER and we are
3360 processing the main hosts and there are fallback hosts available, put the
3361 address on the list for fallback delivery. */
3362
3363 if (addr->transport_return == DEFER &&
3364 addr->fallback_hosts != NULL &&
3365 !fallback &&
3366 msg == NULL)
3367 {
3368 addr->host_list = addr->fallback_hosts;
3369 addr->next = addr_fallback;
3370 addr_fallback = addr;
3371 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3372 }
3373
3374 /* If msg is set (=> unexpected problem), set it in the address before
3375 doing the ordinary post processing. */
3376
3377 else
3378 {
3379 if (msg != NULL)
3380 {
3381 addr->message = msg;
3382 addr->transport_return = DEFER;
3383 }
3384 (void)post_process_one(addr, addr->transport_return, logflags,
3385 DTYPE_TRANSPORT, addr->special_action);
3386 }
3387
3388 /* Next address */
3389
3390 addr = next;
3391 }
3392
3393/* If we have just delivered down a passed SMTP channel, and that was
3394the last address, the channel will have been closed down. Now that
3395we have logged that delivery, set continue_sequence to 1 so that
3396any subsequent deliveries don't get "*" incorrectly logged. */
3397
3398if (continue_transport == NULL) continue_sequence = 1;
3399}
3400
3401
3402
3403/*************************************************
3404* Wait for one remote delivery subprocess *
3405*************************************************/
3406
3407/* This function is called while doing remote deliveries when either the
3408maximum number of processes exist and we need one to complete so that another
3409can be created, or when waiting for the last ones to complete. It must wait for
3410the completion of one subprocess, empty the control block slot, and return a
3411pointer to the address chain.
3412
3413Arguments: none
3414Returns: pointer to the chain of addresses handled by the process;
3415 NULL if no subprocess found - this is an unexpected error
3416*/
3417
3418static address_item *
3419par_wait(void)
3420{
3421int poffset, status;
3422address_item *addr, *addrlist;
3423pid_t pid;
3424
3425set_process_info("delivering %s: waiting for a remote delivery subprocess "
3426 "to finish", message_id);
3427
3428/* Loop until either a subprocess completes, or there are no subprocesses in
3429existence - in which case give an error return. We cannot proceed just by
3430waiting for a completion, because a subprocess may have filled up its pipe, and
3431be waiting for it to be emptied. Therefore, if no processes have finished, we
3432wait for one of the pipes to acquire some data by calling select(), with a
3433timeout just in case.
3434
3435The simple approach is just to iterate after reading data from a ready pipe.
3436This leads to non-ideal behaviour when the subprocess has written its final Z
3437item, closed the pipe, and is in the process of exiting (the common case). A
3438call to waitpid() yields nothing completed, but select() shows the pipe ready -
3439reading it yields EOF, so you end up with busy-waiting until the subprocess has
3440actually finished.
3441
3442To avoid this, if all the data that is needed has been read from a subprocess
3443after select(), an explicit wait() for it is done. We know that all it is doing
3444is writing to the pipe and then exiting, so the wait should not be long.
3445
3446The non-blocking waitpid() is to some extent just insurance; if we could
3447reliably detect end-of-file on the pipe, we could always know when to do a
3448blocking wait() for a completed process. However, because some systems use
3449NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3450use code that functions without the need to recognize EOF.
3451
3452There's a double loop here just in case we end up with a process that is not in
3453the list of remote delivery processes. Something has obviously gone wrong if
3454this is the case. (For example, a process that is incorrectly left over from
3455routing or local deliveries might be found.) The damage can be minimized by
3456looping back and looking for another process. If there aren't any, the error
3457return will happen. */
3458
3459for (;;) /* Normally we do not repeat this loop */
3460 {
3461 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3462 {
3463 struct timeval tv;
3464 fd_set select_pipes;
3465 int maxpipe, readycount;
3466
3467 /* A return value of -1 can mean several things. If errno != ECHILD, it
3468 either means invalid options (which we discount), or that this process was
3469 interrupted by a signal. Just loop to try the waitpid() again.
3470
3471 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3472 in existence. This should never happen, and is an unexpected error.
3473 However, there is a nasty complication when running under Linux. If "strace
3474 -f" is being used under Linux to trace this process and its children,
3475 subprocesses are "stolen" from their parents and become the children of the
3476 tracing process. A general wait such as the one we've just obeyed returns
3477 as if there are no children while subprocesses are running. Once a
3478 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3479 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3480 palliative.
3481
3482 This does not happen using "truss" on Solaris, nor (I think) with other
3483 tracing facilities on other OS. It seems to be specific to Linux.
3484
3485 What we do to get round this is to use kill() to see if any of our
3486 subprocesses are still in existence. If kill() gives an OK return, we know
3487 it must be for one of our processes - it can't be for a re-use of the pid,
3488 because if our process had finished, waitpid() would have found it. If any
3489 of our subprocesses are in existence, we proceed to use select() as if
3490 waitpid() had returned zero. I think this is safe. */
3491
3492 if (pid < 0)
3493 {
3494 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3495
3496 DEBUG(D_deliver)
3497 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3498 "for process existence\n");
3499
3500 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3501 {
3502 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3503 {
3504 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3505 "stolen by strace\n", (int)pid);
3506 break; /* With poffset set */
3507 }
3508 }
3509
3510 if (poffset >= remote_max_parallel)
3511 {
3512 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3513 return NULL; /* This is the error return */
3514 }
3515 }
3516
3517 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3518 been handled above. A return value of zero means that there is at least one
3519 subprocess, but there are no completed subprocesses. See if any pipes are
3520 ready with any data for reading. */
3521
3522 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3523
3524 maxpipe = 0;
3525 FD_ZERO(&select_pipes);
3526 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3527 {
3528 if (parlist[poffset].pid != 0)
3529 {
3530 int fd = parlist[poffset].fd;
3531 FD_SET(fd, &select_pipes);
3532 if (fd > maxpipe) maxpipe = fd;
3533 }
3534 }
3535
3536 /* Stick in a 60-second timeout, just in case. */
3537
3538 tv.tv_sec = 60;
3539 tv.tv_usec = 0;
3540
3541 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3542 NULL, NULL, &tv);
3543
3544 /* Scan through the pipes and read any that are ready; use the count
3545 returned by select() to stop when there are no more. Select() can return
3546 with no processes (e.g. if interrupted). This shouldn't matter.
3547
3548 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3549 read, or there was a disaster. In either case, we are finished with this
3550 process. Do an explicit wait() for the process and break the main loop if
3551 it succeeds.
3552
3553 It turns out that we have to deal with the case of an interrupted system
3554 call, which can happen on some operating systems if the signal handling is
3555 set up to do that by default. */
3556
3557 for (poffset = 0;
3558 readycount > 0 && poffset < remote_max_parallel;
3559 poffset++)
3560 {
3561 if ((pid = parlist[poffset].pid) != 0 &&
3562 FD_ISSET(parlist[poffset].fd, &select_pipes))
3563 {
3564 readycount--;
3565 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3566 {
3567 for (;;) /* Loop for signals */
3568 {
3569 pid_t endedpid = waitpid(pid, &status, 0);
3570 if (endedpid == pid) goto PROCESS_DONE;
3571 if (endedpid != (pid_t)(-1) || errno != EINTR)
3572 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3573 "%d (errno = %d) from waitpid() for process %d",
3574 (int)endedpid, errno, (int)pid);
3575 }
3576 }
3577 }
3578 }
3579
3580 /* Now go back and look for a completed subprocess again. */
3581 }
3582
3583 /* A completed process was detected by the non-blocking waitpid(). Find the
3584 data block that corresponds to this subprocess. */
3585
3586 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3587 if (pid == parlist[poffset].pid) break;
3588
3589 /* Found the data block; this is a known remote delivery process. We don't
3590 need to repeat the outer loop. This should be what normally happens. */
3591
3592 if (poffset < remote_max_parallel) break;
3593
3594 /* This situation is an error, but it's probably better to carry on looking
3595 for another process than to give up (as we used to do). */
3596
3597 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3598 "transport process list", pid);
3599 } /* End of the "for" loop */
3600
3601/* Come here when all the data was completely read after a select(), and
3602the process in pid has been wait()ed for. */
3603
3604PROCESS_DONE:
3605
3606DEBUG(D_deliver)
3607 {
3608 if (status == 0)
3609 debug_printf("remote delivery process %d ended\n", (int)pid);
3610 else
3611 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3612 status);
3613 }
3614
3615set_process_info("delivering %s", message_id);
3616
3617/* Get the chain of processed addresses */
3618
3619addrlist = parlist[poffset].addrlist;
3620
3621/* If the process did not finish cleanly, record an error and freeze (except
3622for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3623in case the delivery did actually happen. */
3624
3625if ((status & 0xffff) != 0)
3626 {
3627 uschar *msg;
3628 int msb = (status >> 8) & 255;
3629 int lsb = status & 255;
3630 int code = (msb == 0)? (lsb & 0x7f) : msb;
3631
3632 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3633 "%s %d",
3634 addrlist->transport->driver_name,
3635 status,
3636 (msb == 0)? "terminated by signal" : "exit code",
3637 code);
3638
3639 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3640 addrlist->special_action = SPECIAL_FREEZE;
3641
3642 for (addr = addrlist; addr != NULL; addr = addr->next)
3643 {
3644 addr->transport_return = DEFER;
3645 addr->message = msg;
3646 }
3647
3648 remove_journal = FALSE;
3649 }
3650
3651/* Else complete reading the pipe to get the result of the delivery, if all
3652the data has not yet been obtained. */
3653
3654else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3655
3656/* Put the data count and return path into globals, mark the data slot unused,
3657decrement the count of subprocesses, and return the address chain. */
3658
3659transport_count = parlist[poffset].transport_count;
3660used_return_path = parlist[poffset].return_path;
3661parlist[poffset].pid = 0;
3662parcount--;
3663return addrlist;
3664}
3665
3666
3667
3668/*************************************************
3669* Wait for subprocesses and post-process *
3670*************************************************/
3671
3672/* This function waits for subprocesses until the number that are still running
3673is below a given threshold. For each complete subprocess, the addresses are
3674post-processed. If we can't find a running process, there is some shambles.
3675Better not bomb out, as that might lead to multiple copies of the message. Just
3676log and proceed as if all done.
3677
3678Arguments:
3679 max maximum number of subprocesses to leave running
3680 fallback TRUE if processing fallback hosts
3681
3682Returns: nothing
3683*/
3684
3685static void
3686par_reduce(int max, BOOL fallback)
3687{
3688while (parcount > max)
3689 {
3690 address_item *doneaddr = par_wait();
3691 if (doneaddr == NULL)
3692 {
3693 log_write(0, LOG_MAIN|LOG_PANIC,
3694 "remote delivery process count got out of step");
3695 parcount = 0;
3696 }
3697 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3698 }
3699}
3700
3701
3702
3703
1ac6b2e7 3704static void
bd21a787 3705rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
1ac6b2e7 3706{
bd21a787
WB
3707uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3708int header_length;
3709
3710/* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3711/* complain to log if someone tries with buffer sizes we can't handle*/
3712
3713if (size > 99999)
3714{
3715 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3716 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3717 size = 99999;
3718}
3719
3720/* to keep the write() atomic we build header in writebuffer and copy buf behind */
3721/* two write() calls would increase the complexity of reading from pipe */
3722
3723/* convert size to human readable string prepended by id and subid */
b75960c8 3724header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
bd21a787
WB
3725if (header_length != PIPE_HEADER_SIZE)
3726{
3727 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3728 writebuffer[0] = '\0';
3729}
3730
3731DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3732 id, subid, size, writebuffer);
3733
3734if (buf && size > 0)
3735 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3736
3737size += PIPE_HEADER_SIZE;
3738int ret = write(fd, writebuffer, size);
1ac6b2e7
JH
3739if(ret != size)
3740 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3741 ret == -1 ? strerror(errno) : "short write");
3742}
3743
059ec3d9
PH
3744/*************************************************
3745* Do remote deliveries *
3746*************************************************/
3747
3748/* This function is called to process the addresses in addr_remote. We must
3749pick off the queue all addresses that have the same transport, remote
3750destination, and errors address, and hand them to the transport in one go,
3751subject to some configured limitations. If this is a run to continue delivering
3752to an existing delivery channel, skip all but those addresses that can go to
3753that channel. The skipped addresses just get deferred.
3754
3755If mua_wrapper is set, all addresses must be able to be sent in a single
3756transaction. If not, this function yields FALSE.
3757
3758In Exim 4, remote deliveries are always done in separate processes, even
3759if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3760is so that the base process can retain privilege. This makes the
3761implementation of fallback transports feasible (though not initially done.)
3762
3763We create up to the configured number of subprocesses, each of which passes
3764back the delivery state via a pipe. (However, when sending down an existing
3765connection, remote_max_parallel is forced to 1.)
3766
3767Arguments:
3768 fallback TRUE if processing fallback hosts
3769
3770Returns: TRUE normally
3771 FALSE if mua_wrapper is set and the addresses cannot all be sent
3772 in one transaction
3773*/
3774
3775static BOOL
3776do_remote_deliveries(BOOL fallback)
3777{
3778int parmax;
3779int delivery_count;
3780int poffset;
3781
3782parcount = 0; /* Number of executing subprocesses */
3783
3784/* When sending down an existing channel, only do one delivery at a time.
3785We use a local variable (parmax) to hold the maximum number of processes;
3786this gets reduced from remote_max_parallel if we can't create enough pipes. */
3787
3788if (continue_transport != NULL) remote_max_parallel = 1;
3789parmax = remote_max_parallel;
3790
3791/* If the data for keeping a list of processes hasn't yet been
3792set up, do so. */
3793
3794if (parlist == NULL)
3795 {
3796 parlist = store_get(remote_max_parallel * sizeof(pardata));
3797 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3798 parlist[poffset].pid = 0;
3799 }
3800
3801/* Now loop for each remote delivery */
3802
3803for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3804 {
3805 pid_t pid;
3806 uid_t uid;
3807 gid_t gid;
3808 int pfd[2];
3809 int address_count = 1;
3810 int address_count_max;
3811 BOOL multi_domain;
3812 BOOL use_initgroups;
3813 BOOL pipe_done = FALSE;
3814 transport_instance *tp;
3815 address_item **anchor = &addr_remote;
3816 address_item *addr = addr_remote;
3817 address_item *last = addr;
3818 address_item *next;
3819
3820 /* Pull the first address right off the list. */
3821
3822 addr_remote = addr->next;
3823 addr->next = NULL;
3824
3825 DEBUG(D_deliver|D_transport)
3826 debug_printf("--------> %s <--------\n", addr->address);
3827
3828 /* If no transport has been set, there has been a big screw-up somewhere. */
3829
3830 if ((tp = addr->transport) == NULL)
3831 {
3832 disable_logging = FALSE; /* Jic */
3833 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3834 US"No transport set by router", fallback);
3835 continue;
3836 }
3837
3838 /* Check that this base address hasn't previously been delivered to this
3839 transport. The check is necessary at this point to handle homonymic addresses
3840 correctly in cases where the pattern of redirection changes between delivery
3841 attempts. Non-homonymic previous delivery is detected earlier, at routing
3842 time. */
3843
c2c19e9d 3844 if (previously_transported(addr, FALSE)) continue;
059ec3d9
PH
3845
3846 /* Force failure if the message is too big. */
3847
3848 if (tp->message_size_limit != NULL)
3849 {
3850 int rc = check_message_size(tp, addr);
3851 if (rc != OK)
3852 {
3853 addr->transport_return = rc;
3854 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3855 continue;
3856 }
3857 }
3858
3859 /* Get the flag which specifies whether the transport can handle different
506900af
JH
3860 domains that nevertheless resolve to the same set of hosts. If it needs
3861 expanding, get variables set: $address_data, $domain_data, $localpart_data,
3862 $host, $host_address, $host_port. */
3863 if (tp->expand_multi_domain)
3864 deliver_set_expansions(addr);
3865
3866 if (exp_bool(addr, US"transport", tp->name, D_transport,
3867 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
3868 &multi_domain) != OK)
3869 {
3870 deliver_set_expansions(NULL);
3871 remote_post_process(addr, LOG_MAIN|LOG_PANIC, addr->message, fallback);
3872 continue;
3873 }
059ec3d9
PH
3874
3875 /* Get the maximum it can handle in one envelope, with zero meaning
3876 unlimited, which is forced for the MUA wrapper case. */
3877
3878 address_count_max = tp->max_addresses;
3879 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3880
3881
3882 /************************************************************************/
3883 /***** This is slightly experimental code, but should be safe. *****/
3884
3885 /* The address_count_max value is the maximum number of addresses that the
3886 transport can send in one envelope. However, the transport must be capable of
3887 dealing with any number of addresses. If the number it gets exceeds its
3888 envelope limitation, it must send multiple copies of the message. This can be
3889 done over a single connection for SMTP, so uses less resources than making
3890 multiple connections. On the other hand, if remote_max_parallel is greater
3891 than one, it is perhaps a good idea to use parallel processing to move the
3892 message faster, even if that results in multiple simultaneous connections to
3893 the same host.
3894
3895 How can we come to some compromise between these two ideals? What we do is to
3896 limit the number of addresses passed to a single instance of a transport to
3897 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3898 number of addresses routed to remote transports divided by
3899 remote_max_parallel. For example, if the message has 100 remote recipients,
3900 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3901 once. But if rcpt_max is 100, we could send up to 100.
3902
3903 Of course, not all the remotely addresses in a message are going to go to the
3904 same set of hosts (except in smarthost configurations), so this is just a
3905 heuristic way of dividing up the work.
3906
3907 Furthermore (1), because this may not be wanted in some cases, and also to
3908 cope with really pathological cases, there is also a limit to the number of
3909 messages that are sent over one connection. This is the same limit that is
3910 used when sending several different messages over the same connection.
3911 Continue_sequence is set when in this situation, to the number sent so
3912 far, including this message.
3913
3914 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3915 is probably because they are using VERP, in which case they want to pass only
3916 one address at a time to the transport, in order to be able to use
3917 $local_part and $domain in constructing a new return path. We could test for
3918 the use of these variables, but as it is so likely they will be used when the
3919 maximum is 1, we don't bother. Just leave the value alone. */
3920
3921 if (address_count_max != 1 &&
3922 address_count_max < remote_delivery_count/remote_max_parallel)
3923 {
3924 int new_max = remote_delivery_count/remote_max_parallel;
3925 int message_max = tp->connection_max_messages;
3926 if (connection_max_messages >= 0) message_max = connection_max_messages;
3927 message_max -= continue_sequence - 1;
3928 if (message_max > 0 && new_max > address_count_max * message_max)
3929 new_max = address_count_max * message_max;
3930 address_count_max = new_max;
3931 }
3932
3933 /************************************************************************/
3934
3935
3936 /* Pick off all addresses which have the same transport, errors address,
3937 destination, and extra headers. In some cases they point to the same host
3938 list, but we also need to check for identical host lists generated from
3939 entirely different domains. The host list pointers can be NULL in the case
3940 where the hosts are defined in the transport. There is also a configured
3941 maximum limit of addresses that can be handled at once (see comments above
506900af
JH
3942 for how it is computed).
3943 If the transport does not handle multiple domains, enforce that also,
3944 and if it might need a per-address check for this, re-evaluate it.
3945 */
059ec3d9
PH
3946
3947 while ((next = *anchor) != NULL && address_count < address_count_max)
3948 {
506900af
JH
3949 BOOL md;
3950 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3951 && tp == next->transport
3952 && same_hosts(next->host_list, addr->host_list)
d43cbe25
JH
3953 && same_strings(next->prop.errors_address, addr->prop.errors_address)
3954 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
506900af 3955 && same_ugid(tp, next, addr)
d43cbe25
JH
3956 && ( next->prop.remove_headers == addr->prop.remove_headers
3957 || ( next->prop.remove_headers
3958 && addr->prop.remove_headers
3959 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
506900af
JH
3960 ) )
3961 && ( !multi_domain
3962 || ( (
3963 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
3964 exp_bool(addr,
3965 US"transport", next->transport->name, D_transport,
3966 US"multi_domain", next->transport->multi_domain,
3967 next->transport->expand_multi_domain, &md) == OK
3968 )
3969 && md
3970 ) ) )
059ec3d9
PH
3971 {
3972 *anchor = next->next;
3973 next->next = NULL;
3974 next->first = addr; /* remember top one (for retry processing) */
3975 last->next = next;
3976 last = next;
3977 address_count++;
3978 }
3979 else anchor = &(next->next);
506900af 3980 deliver_set_expansions(NULL);
059ec3d9
PH
3981 }
3982
3983 /* If we are acting as an MUA wrapper, all addresses must go in a single
3984 transaction. If not, put them back on the chain and yield FALSE. */
3985
3986 if (mua_wrapper && addr_remote != NULL)
3987 {
3988 last->next = addr_remote;
3989 addr_remote = addr;
3990 return FALSE;
3991 }
3992
3993 /* Set up the expansion variables for this set of addresses */
3994
3995 deliver_set_expansions(addr);
3996
018c60d7
JH
3997 /* Ensure any transport-set auth info is fresh */
3998 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3999
059ec3d9
PH
4000 /* Compute the return path, expanding a new one if required. The old one
4001 must be set first, as it might be referred to in the expansion. */
4002
d43cbe25
JH
4003 if(addr->prop.errors_address != NULL)
4004 return_path = addr->prop.errors_address;
384152a6 4005#ifdef EXPERIMENTAL_SRS
d43cbe25
JH
4006 else if(addr->prop.srs_sender != NULL)
4007 return_path = addr->prop.srs_sender;
384152a6
TK
4008#endif
4009 else
4010 return_path = sender_address;
059ec3d9
PH
4011
4012 if (tp->return_path != NULL)
4013 {
4014 uschar *new_return_path = expand_string(tp->return_path);
4015 if (new_return_path == NULL)
4016 {
4017 if (!expand_string_forcedfail)
4018 {
4019 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4020 string_sprintf("Failed to expand return path \"%s\": %s",
4021 tp->return_path, expand_string_message), fallback);
4022 continue;
4023 }
4024 }
4025 else return_path = new_return_path;
4026 }
4027
929ba01c
PH
4028 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4029 logs and sets up error messages, so we just post-process and continue with
4030 the next address. */
4031
4032 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4033 {
4034 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
4035 continue;
4036 }
4037
059ec3d9
PH
4038 /* If this transport has a setup function, call it now so that it gets
4039 run in this process and not in any subprocess. That way, the results of
929ba01c
PH
4040 any setup that are retained by the transport can be reusable. One of the
4041 things the setup does is to set the fallback host lists in the addresses.
4042 That is why it is called at this point, before the continue delivery
4043 processing, because that might use the fallback hosts. */
059ec3d9
PH
4044
4045 if (tp->setup != NULL)
929ba01c 4046 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
059ec3d9
PH
4047
4048 /* If this is a run to continue delivery down an already-established
4049 channel, check that this set of addresses matches the transport and
4050 the channel. If it does not, defer the addresses. If a host list exists,
4051 we must check that the continue host is on the list. Otherwise, the
4052 host is set in the transport. */
4053
4054 continue_more = FALSE; /* In case got set for the last lot */
4055 if (continue_transport != NULL)
4056 {
4057 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4058 if (ok && addr->host_list != NULL)
4059 {
4060 host_item *h;
4061 ok = FALSE;
4062 for (h = addr->host_list; h != NULL; h = h->next)
4063 {
4064 if (Ustrcmp(h->name, continue_hostname) == 0)
4065 { ok = TRUE; break; }
4066 }
4067 }
4068
4069 /* Addresses not suitable; defer or queue for fallback hosts (which
4070 might be the continue host) and skip to next address. */
4071
4072 if (!ok)
4073 {
4074 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4075 next = addr;
4076
4077 if (addr->fallback_hosts != NULL && !fallback)
4078 {
4079 for (;;)
4080 {
4081 next->host_list = next->fallback_hosts;
4082 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4083 if (next->next == NULL) break;
4084 next = next->next;
4085 }
4086 next->next = addr_fallback;
4087 addr_fallback = addr;
4088 }
4089
4090 else
4091 {
4092 while (next->next != NULL) next = next->next;
4093 next->next = addr_defer;
4094 addr_defer = addr;
4095 }
4096
4097 continue;
4098 }
4099
4100 /* Set a flag indicating whether there are further addresses that list
4101 the continued host. This tells the transport to leave the channel open,
4102 but not to pass it to another delivery process. */
4103
4104 for (next = addr_remote; next != NULL; next = next->next)
4105 {
4106 host_item *h;
4107 for (h = next->host_list; h != NULL; h = h->next)
4108 {
4109 if (Ustrcmp(h->name, continue_hostname) == 0)
4110 { continue_more = TRUE; break; }
4111 }
4112 }
4113 }
4114
4115 /* The transports set up the process info themselves as they may connect
4116 to more than one remote machine. They also have to set up the filter
4117 arguments, if required, so that the host name and address are available
4118 for expansion. */
4119
4120 transport_filter_argv = NULL;
4121
059ec3d9
PH
4122 /* Create the pipe for inter-process communication. If pipe creation
4123 fails, it is probably because the value of remote_max_parallel is so
4124 large that too many file descriptors for pipes have been created. Arrange
4125 to wait for a process to finish, and then try again. If we still can't
4126 create a pipe when all processes have finished, break the retry loop. */
4127
4128 while (!pipe_done)
4129 {
4130 if (pipe(pfd) == 0) pipe_done = TRUE;
4131 else if (parcount > 0) parmax = parcount;
4132 else break;
4133
4134 /* We need to make the reading end of the pipe non-blocking. There are
4135 two different options for this. Exim is cunningly (I hope!) coded so
4136 that it can use either of them, though it prefers O_NONBLOCK, which
4137 distinguishes between EOF and no-more-data. */
4138
a7538db1 4139#ifdef O_NONBLOCK
ff790e47 4140 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
a7538db1 4141#else
ff790e47 4142 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
a7538db1 4143#endif
059ec3d9
PH
4144
4145 /* If the maximum number of subprocesses already exist, wait for a process
4146 to finish. If we ran out of file descriptors, parmax will have been reduced
4147 from its initial value of remote_max_parallel. */
4148
4149 par_reduce(parmax - 1, fallback);
4150 }
4151
4152 /* If we failed to create a pipe and there were no processes to wait
4153 for, we have to give up on this one. Do this outside the above loop
4154 so that we can continue the main loop. */
4155
4156 if (!pipe_done)
4157 {
4158 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4159 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
4160 continue;
4161 }
4162
4163 /* Find a free slot in the pardata list. Must do this after the possible
4164 waiting for processes to finish, because a terminating process will free
4165 up a slot. */
4166
4167 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4168 if (parlist[poffset].pid == 0) break;
4169
4170 /* If there isn't one, there has been a horrible disaster. */
4171
4172 if (poffset >= remote_max_parallel)
4173 {
f1e894f3
PH
4174 (void)close(pfd[pipe_write]);
4175 (void)close(pfd[pipe_read]);
059ec3d9
PH
4176 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4177 US"Unexpectedly no free subprocess slot", fallback);
4178 continue;
4179 }
4180
4181 /* Now fork a subprocess to do the remote delivery, but before doing so,
4182 ensure that any cached resourses are released so as not to interfere with
4183 what happens in the subprocess. */
4184
4185 search_tidyup();
4186
4187 if ((pid = fork()) == 0)
4188 {
4189 int fd = pfd[pipe_write];
4190 host_item *h;
4191
2a47f028
JH
4192 /* Setting this global in the subprocess means we need never clear it */
4193 transport_name = tp->name;
059ec3d9 4194
2a47f028 4195 /* There are weird circumstances in which logging is disabled */
059ec3d9
PH
4196 disable_logging = tp->disable_logging;
4197
4198 /* Show pids on debug output if parallelism possible */
4199
4200 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
4201 {
4202 DEBUG(D_any|D_v) debug_selector |= D_pid;
4203 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4204 }
4205
4206 /* Reset the random number generator, so different processes don't all
4207 have the same sequence. In the test harness we want different, but
4208 predictable settings for each delivery process, so do something explicit
4209 here rather they rely on the fixed reset in the random number function. */
4210
4211 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4212
4213 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4214 a new process that may be forked to do another delivery down the same
4215 SMTP connection. */
4216
ff790e47 4217 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
059ec3d9
PH
4218
4219 /* Close open file descriptors for the pipes of other processes
4220 that are running in parallel. */
4221
4222 for (poffset = 0; poffset < remote_max_parallel; poffset++)
f1e894f3 4223 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
059ec3d9
PH
4224
4225 /* This process has inherited a copy of the file descriptor
4226 for the data file, but its file pointer is shared with all the
4227 other processes running in parallel. Therefore, we have to re-open
4228 the file in order to get a new file descriptor with its own
4229 file pointer. We don't need to lock it, as the lock is held by
4230 the parent process. There doesn't seem to be any way of doing
4231 a dup-with-new-file-pointer. */
4232
f1e894f3 4233 (void)close(deliver_datafile);
059ec3d9
PH
4234 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4235 message_id);
4236 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4237
4238 if (deliver_datafile < 0)
4239 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4240 "parallel delivery: %s", spoolname, strerror(errno));
4241
4242 /* Set the close-on-exec flag */
4243
ff790e47 4244 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
059ec3d9
PH
4245 FD_CLOEXEC);
4246
4247 /* Set the uid/gid of this process; bombs out on failure. */
4248
4249 exim_setugid(uid, gid, use_initgroups,
4250 string_sprintf("remote delivery to %s with transport=%s",
4251 addr->address, tp->name));
4252
4253 /* Close the unwanted half of this process' pipe, set the process state,
4254 and run the transport. Afterwards, transport_count will contain the number
4255 of bytes written. */
4256
f1e894f3 4257 (void)close(pfd[pipe_read]);
059ec3d9
PH
4258 set_process_info("delivering %s using %s", message_id, tp->name);
4259 debug_print_string(tp->debug_string);
4260 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4261
4262 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4263 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4264
4265 /* Ensure any cached resources that we used are now released */
4266
4267 search_tidyup();
4268
4269 /* Pass the result back down the pipe. This is a lot more information
4270 than is needed for a local delivery. We have to send back the error
4271 status for each address, the usability status for each host that is
4272 flagged as unusable, and all the retry items. When TLS is in use, we
4273 send also the cipher and peerdn information. Each type of information
4274 is flagged by an identifying byte, and is then in a fixed format (with
4275 strings terminated by zeros), and there is a final terminator at the
4276 end. The host information and retry information is all attached to
4277 the first address, so that gets sent at the start. */
4278
4279 /* Host unusability information: for most success cases this will
4280 be null. */
4281
4282 for (h = addr->host_list; h != NULL; h = h->next)
4283 {
4284 if (h->address == NULL || h->status < hstatus_unusable) continue;
bd21a787
WB
4285 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4286 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
059ec3d9
PH
4287 }
4288
4289 /* The number of bytes written. This is the same for each address. Even
4290 if we sent several copies of the message down the same connection, the
4291 size of each one is the same, and it's that value we have got because
4292 transport_count gets reset before calling transport_write_message(). */
4293
bd21a787
WB
4294 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4295 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
059ec3d9 4296
6f123593
JH
4297 /* Information about what happened to each address. Four item types are
4298 used: an optional 'X' item first, for TLS information, then an optional "C"
4299 item for any client-auth info followed by 'R' items for any retry settings,
4300 and finally an 'A' item for the remaining data. */
059ec3d9
PH
4301
4302 for(; addr != NULL; addr = addr->next)
4303 {
4304 uschar *ptr;
4305 retry_item *r;
4306
4307 /* The certificate verification status goes into the flags */
817d9f57 4308 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
a0a2d1ee 4309#ifdef EXPERIMENTAL_DANE
53a7196b 4310 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
a0a2d1ee 4311#endif
059ec3d9
PH
4312
4313 /* Use an X item only if there's something to send */
a7538db1 4314#ifdef SUPPORT_TLS
9d1c15ef 4315 if (addr->cipher)
059ec3d9
PH
4316 {
4317 ptr = big_buffer;
bd21a787 4318 sprintf(CS ptr, "%.128s", addr->cipher);
059ec3d9 4319 while(*ptr++);
9d1c15ef
JH
4320 if (!addr->peerdn)
4321 *ptr++ = 0;
4322 else
059ec3d9
PH
4323 {
4324 sprintf(CS ptr, "%.512s", addr->peerdn);
4325 while(*ptr++);
4326 }
9d1c15ef 4327
bd21a787 4328 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
059ec3d9 4329 }
9d1c15ef
JH
4330 if (addr->peercert)
4331 {
4332 ptr = big_buffer;
9d1c15ef
JH
4333 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4334 while(*ptr++);
4335 else
4336 *ptr++ = 0;
bd21a787 4337 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
9d1c15ef
JH
4338 }
4339 if (addr->ourcert)
4340 {
4341 ptr = big_buffer;
9d1c15ef
JH
4342 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4343 while(*ptr++);
4344 else
4345 *ptr++ = 0;
bd21a787 4346 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
9d1c15ef 4347 }
a7538db1 4348# ifndef DISABLE_OCSP
018058b2
JH
4349 if (addr->ocsp > OCSP_NOT_REQ)
4350 {
4351 ptr = big_buffer;
bd21a787 4352 sprintf(CS ptr, "%c", addr->ocsp + '0');
018058b2 4353 while(*ptr++);
bd21a787 4354 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
018058b2 4355 }
a7538db1
JH
4356# endif
4357#endif /*SUPPORT_TLS*/
059ec3d9 4358
6f123593
JH
4359 if (client_authenticator)
4360 {
4361 ptr = big_buffer;
bd21a787 4362 sprintf(CS big_buffer, "%.64s", client_authenticator);
6f123593 4363 while(*ptr++);
bd21a787 4364 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
6f123593
JH
4365 }
4366 if (client_authenticated_id)
4367 {
4368 ptr = big_buffer;
bd21a787 4369 sprintf(CS big_buffer, "%.64s", client_authenticated_id);
6f123593 4370 while(*ptr++);
bd21a787 4371 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
6f123593 4372 }
c8e2fc1e
JH
4373 if (client_authenticated_sender)
4374 {
4375 ptr = big_buffer;
bd21a787 4376 sprintf(CS big_buffer, "%.64s", client_authenticated_sender);
c8e2fc1e 4377 while(*ptr++);
bd21a787 4378 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
c8e2fc1e 4379 }
6f123593 4380
a7538db1 4381#ifndef DISABLE_PRDR
783b385f 4382 if (addr->flags & af_prdr_used)
bd21a787 4383 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
b75960c8 4384#endif
fd98a5c6 4385
bd21a787
WB
4386 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4387 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
6c1c3d1d 4388 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
6c1c3d1d 4389
059ec3d9
PH
4390 /* Retry information: for most success cases this will be null. */
4391
4392 for (r = addr->retries; r != NULL; r = r->next)
4393 {
4394 uschar *ptr;
bd21a787 4395 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
059ec3d9
PH
4396 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4397 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4398 ptr += sizeof(r->basic_errno);
4399 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4400 ptr += sizeof(r->more_errno);
4401 if (r->message == NULL) *ptr++ = 0; else
4402 {
4403 sprintf(CS ptr, "%.512s", r->message);
4404 while(*ptr++);
4405 }
bd21a787 4406 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
059ec3d9
PH
4407 }
4408
4409 /* The rest of the information goes in an 'A' item. */
4410
bd21a787
WB
4411 ptr = big_buffer + 2;
4412 sprintf(CS big_buffer, "%c%c", addr->transport_return,
059ec3d9
PH
4413 addr->special_action);
4414 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4415 ptr += sizeof(addr->basic_errno);
4416 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4417 ptr += sizeof(addr->more_errno);
4418 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4419 ptr += sizeof(addr->flags);
4420
4421 if (addr->message == NULL) *ptr++ = 0; else
4422 {
4423 sprintf(CS ptr, "%.1024s", addr->message);
4424 while(*ptr++);
4425 }
4426
4427 if (addr->user_message == NULL) *ptr++ = 0; else
4428 {
4429 sprintf(CS ptr, "%.1024s", addr->user_message);
4430 while(*ptr++);
4431 }
4432
4433 if (addr->host_used == NULL) *ptr++ = 0; else
4434 {
4435 sprintf(CS ptr, "%.256s", addr->host_used->name);
4436 while(*ptr++);
4437 sprintf(CS ptr, "%.64s", addr->host_used->address);
4438 while(*ptr++);
4439 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4440 ptr += sizeof(addr->host_used->port);
783b385f
JH
4441
4442 /* DNS lookup status */
4443 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4444 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4445
059ec3d9 4446 }
bd21a787 4447 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
059ec3d9
PH
4448 }
4449
aeaf5db3
JH
4450 /* Local interface address/port */
4451 if (log_extra_selector & LX_incoming_interface && sending_ip_address)
4452 {
4453 uschar * ptr = big_buffer;
4454 sprintf(CS ptr, "%.128s", sending_ip_address);
4455 while(*ptr++);
4456 sprintf(CS ptr, "%d", sending_port);
4457 while(*ptr++);
4458
4459 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4460 }
4461
059ec3d9
PH
4462 /* Add termination flag, close the pipe, and that's it. The character
4463 after 'Z' indicates whether continue_transport is now NULL or not.
4464 A change from non-NULL to NULL indicates a problem with a continuing
4465 connection. */
4466
bd21a787
WB
4467 big_buffer[0] = (continue_transport == NULL)? '0' : '1';
4468 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
f1e894f3 4469 (void)close(fd);
059ec3d9
PH
4470 exit(EXIT_SUCCESS);
4471 }
4472
4473 /* Back in the mainline: close the unwanted half of the pipe. */
4474
f1e894f3 4475 (void)close(pfd[pipe_write]);
059ec3d9
PH
4476
4477 /* Fork failed; defer with error message */
4478
4479 if (pid < 0)
4480 {
f1e894f3 4481 (void)close(pfd[pipe_read]);
059ec3d9
PH
4482 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4483 string_sprintf("fork failed for remote delivery to %s: %s",
4484 addr->domain, strerror(errno)), fallback);
4485 continue;
4486 }
4487
4488 /* Fork succeeded; increment the count, and remember relevant data for
4489 when the process finishes. */
4490
4491 parcount++;
4492 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4493 parlist[poffset].pid = pid;
4494 parlist[poffset].fd = pfd[pipe_read];
4495 parlist[poffset].done = FALSE;
4496 parlist[poffset].msg = NULL;
4497 parlist[poffset].return_path = return_path;
4498
4499 /* If the process we've just started is sending a message down an existing
4500 channel, wait for it now. This ensures that only one such process runs at
4501 once, whatever the value of remote_max parallel. Otherwise, we might try to
4502 send two or more messages simultaneously down the same channel. This could
4503 happen if there are different domains that include the same host in otherwise
4504 different host lists.
4505
4506 Also, if the transport closes down the channel, this information gets back
4507 (continue_transport gets set to NULL) before we consider any other addresses
4508 in this message. */
4509
4510 if (continue_transport != NULL) par_reduce(0, fallback);
4511
4512 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4513 newly created process get going before we create another process. This should
4514 ensure repeatability in the tests. We only need to wait a tad. */
4515
4516 else if (running_in_test_harness) millisleep(500);
4517 }
4518
4519/* Reached the end of the list of addresses. Wait for all the subprocesses that
4520are still running and post-process their addresses. */
4521
4522par_reduce(0, fallback);
4523return TRUE;
4524}
4525
4526
4527
4528
4529/*************************************************
4530* Split an address into local part and domain *
4531*************************************************/
4532
4533/* This function initializes an address for routing by splitting it up into a
4534local part and a domain. The local part is set up twice - once in its original
4535casing, and once in lower case, and it is dequoted. We also do the "percent
4536hack" for configured domains. This may lead to a DEFER result if a lookup
4537defers. When a percent-hacking takes place, we insert a copy of the original
4538address as a new parent of this address, as if we have had a redirection.
4539
4540Argument:
4541 addr points to an addr_item block containing the address
4542
4543Returns: OK
4544 DEFER - could not determine if domain is %-hackable
4545*/
4546
4547int
4548deliver_split_address(address_item *addr)
4549{
4550uschar *address = addr->address;
4551uschar *domain = Ustrrchr(address, '@');
4552uschar *t;
4553int len = domain - address;
4554
4555addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4556
4557/* The implication in the RFCs (though I can't say I've seen it spelled out
4558explicitly) is that quoting should be removed from local parts at the point
4559where they are locally interpreted. [The new draft "821" is more explicit on
4560this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4561removing quoting backslashes and any unquoted doublequotes. */
4562
4563t = addr->cc_local_part = store_get(len+1);
4564while(len-- > 0)
4565 {
4566 register int c = *address++;
4567 if (c == '\"') continue;
4568 if (c == '\\')
4569 {
4570 *t++ = *address++;
4571 len--;
4572 }
4573 else *t++ = c;
4574 }
4575*t = 0;
4576
4577/* We do the percent hack only for those domains that are listed in
4578percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4579
4580if (percent_hack_domains != NULL)
4581 {
4582 int rc;
4583 uschar *new_address = NULL;
4584 uschar *local_part = addr->cc_local_part;
4585
4586 deliver_domain = addr->domain; /* set $domain */
4587
55414b25 4588 while ((rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
059ec3d9
PH
4589 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4590 == OK &&
4591 (t = Ustrrchr(local_part, '%')) != NULL)
4592 {
4593 new_address = string_copy(local_part);
4594 new_address[t - local_part] = '@';
4595 deliver_domain = string_copylc(t+1);
4596 local_part = string_copyn(local_part, t - local_part);
4597 }
4598
4599 if (rc == DEFER) return DEFER; /* lookup deferred */
4600
4601 /* If hackery happened, set up new parent and alter the current address. */
4602
4603 if (new_address != NULL)
4604 {
4605 address_item *new_parent = store_get(sizeof(address_item));
4606 *new_parent = *addr;
4607 addr->parent = new_parent;
4608 addr->address = new_address;
4609 addr->unique = string_copy(new_address);
4610 addr->domain = deliver_domain;
4611 addr->cc_local_part = local_part;
4612 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4613 addr->address);
4614 }
4615 }
4616
4617/* Create the lowercased version of the final local part, and make that the
4618default one to be used. */
4619
4620addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4621return OK;
4622}
4623
4624
4625
4626
4627/*************************************************
4628* Get next error message text *
4629*************************************************/
4630
4631/* If f is not NULL, read the next "paragraph", from a customized error message
4632text file, terminated by a line containing ****, and expand it.
4633
4634Arguments:
4635 f NULL or a file to read from
4636 which string indicating which string (for errors)
4637
4638Returns: NULL or an expanded string
4639*/
4640
4641static uschar *
4642next_emf(FILE *f, uschar *which)
4643{
4644int size = 256;
4645int ptr = 0;
4646uschar *para, *yield;
4647uschar buffer[256];
4648
4649if (f == NULL) return NULL;
4650
4651if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4652 Ustrcmp(buffer, "****\n") == 0) return NULL;
4653
4654para = store_get(size);
4655for (;;)
4656 {
4657 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4658 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4659 Ustrcmp(buffer, "****\n") == 0) break;
4660 }
4661para[ptr] = 0;
4662
4663yield = expand_string(para);
4664if (yield != NULL) return yield;
4665
4666log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4667 "bounce_message_file or warn_message_file (%s): %s", which,
4668 expand_string_message);
4669return NULL;
4670}
4671
4672
4673
4674
4675/*************************************************
4676* Close down a passed transport channel *
4677*************************************************/
4678
4679/* This function is called when a passed transport channel cannot be used.
4680It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4681so that the function call can be the argument of a "return" statement.
4682
4683Arguments: None
4684Returns: DELIVER_NOT_ATTEMPTED
4685*/
4686
4687static int
4688continue_closedown(void)
4689{
4690if (continue_transport != NULL)
4691 {
4692 transport_instance *t;
4693 for (t = transports; t != NULL; t = t->next)
4694 {
4695 if (Ustrcmp(t->name, continue_transport) == 0)
4696 {
4697 if (t->info->closedown != NULL) (t->info->closedown)(t);
4698 break;
4699 }
4700 }
4701 }
4702return DELIVER_NOT_ATTEMPTED;
4703}
4704
4705
4706
4707
4708/*************************************************
4709* Print address information *
4710*************************************************/
4711
4712/* This function is called to output an address, or information about an
4713address, for bounce or defer messages. If the hide_child flag is set, all we
4714output is the original ancestor address.
4715
4716Arguments:
4717 addr points to the address
4718 f the FILE to print to
4719 si an initial string
4720 sc a continuation string for before "generated"
4721 se an end string
4722
4723Returns: TRUE if the address is not hidden
4724*/
4725
4726static BOOL
4727print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4728 uschar *se)
4729{
4730BOOL yield = TRUE;
4731uschar *printed = US"";
4732address_item *ancestor = addr;
4733while (ancestor->parent != NULL) ancestor = ancestor->parent;
4734
4735fprintf(f, "%s", CS si);
4736
4737if (addr->parent != NULL && testflag(addr, af_hide_child))
4738 {
4739 printed = US"an undisclosed address";
4740 yield = FALSE;
4741 }
059ec3d9
PH
4742else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4743 printed = addr->address;
4744
4745else
4746 {
4747 uschar *s = addr->address;
4748 uschar *ss;
4749
4750 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4751 else if (addr->address[0] == '|') ss = US"pipe";
4752 else ss = US"save";
4753
4754 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4755 printed = addr->parent->address;
4756 }
4757
4758fprintf(f, "%s", CS string_printing(printed));
4759
4760if (ancestor != addr)
4761 {
4762 uschar *original = (ancestor->onetime_parent == NULL)?
4763 ancestor->address : ancestor->onetime_parent;
4764 if (strcmpic(original, printed) != 0)
4765 fprintf(f, "%s(%sgenerated from %s)", sc,
4766 (ancestor != addr->parent)? "ultimately " : "",
4767 string_printing(original));
4768 }
4769
c562fd30
JH
4770if (addr->host_used)
4771 fprintf(f, "\n host %s [%s]",
4772 addr->host_used->name, addr->host_used->address);
4773
059ec3d9
PH
4774fprintf(f, "%s", CS se);
4775return yield;
4776}
4777
4778
4779
4780
4781
059ec3d9
PH
4782/*************************************************
4783* Print error for an address *
4784*************************************************/
4785
4786/* This function is called to print the error information out of an address for
4787a bounce or a warning message. It tries to format the message reasonably by
4788introducing newlines. All lines are indented by 4; the initial printing
4789position must be set before calling.
4790
447d236c 4791This function used always to print the error. Nowadays we want to restrict it
75def545
PH
4792to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4793and filter "fail". We no longer pass other information willy-nilly in bounce
4794and warning messages. Text in user_message is always output; text in message
4795only if the af_pass_message flag is set.
447d236c 4796
059ec3d9 4797Arguments:
447d236c 4798 addr the address
059ec3d9 4799 f the FILE to print on
75def545 4800 t some leading text
059ec3d9
PH
4801
4802Returns: nothing
4803*/
4804
4805static void
447d236c 4806print_address_error(address_item *addr, FILE *f, uschar *t)
059ec3d9 4807{
447d236c 4808int count = Ustrlen(t);
75def545 4809uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
447d236c 4810
75def545 4811if (s == NULL)
059ec3d9 4812 {
75def545 4813 if (addr->user_message != NULL) s = addr->user_message; else return;
059ec3d9 4814 }
447d236c
PH
4815
4816fprintf(f, "\n %s", t);
4817
4818while (*s != 0)
059ec3d9 4819 {
447d236c
PH
4820 if (*s == '\\' && s[1] == 'n')
4821 {
4822 fprintf(f, "\n ");
4823 s += 2;
4824 count = 0;
4825 }
4826 else
059ec3d9 4827 {
447d236c
PH
4828 fputc(*s, f);
4829 count++;
4830 if (*s++ == ':' && isspace(*s) && count > 45)
059ec3d9 4831 {
447d236c 4832 fprintf(f, "\n "); /* sic (because space follows) */
059ec3d9
PH
4833 count = 0;
4834 }
059ec3d9
PH
4835 }
4836 }
4837}
4838
4839
21bc4865
WB
4840/***********************************************************
4841* Print Diagnostic-Code for an address *
4842************************************************************/
4843
4844/* This function is called to print the error information out of an address for
4845a bounce or a warning message. It tries to format the message reasonably as
4846required by RFC 3461 by adding a space after each newline
4847
4848we assume that this function is only called if addr->host_used is set and if so
4849a useable addr->message is available containing some Exim description with ": \n"
4850ending, followed by the L/SMTP error message.
4851
4852Arguments:
4853 addr the address
4854 f the FILE to print on
4855
4856Returns: nothing
4857*/
4858
4859static void
4860print_dsn_diagnostic_code(const address_item *addr, FILE *f)
4861{
4862uschar * s;
059ec3d9 4863
21bc4865
WB
4864/* check host_used, af_pass_message flag and addr->message for safety reasons */
4865if (!addr->host_used && testflag(addr, af_pass_message) && addr->message)
4866 return;
4867
4868/* search first ": ". we assume to find the remote-MTA answer there */
4869DEBUG(D_deliver)
4870 debug_printf("DSN Diagnostic-Code: addr->dsn_message = %s\n", addr->message);
4871if (!(s = Ustrstr(addr->message, ": ")))
4872 return; /* not found, bail out */
447d236c 4873
21bc4865
WB
4874fprintf(f, "Diagnostic-Code: smtp; ");
4875
4876s += 2; /* skip ": " */
4877while (*s)
4878 if (*s == '\\' && s[1] == 'n')
4879 {
4880 fputs("\n ", f); /* as defined in RFC 3461 */
4881 s += 2;
4882 }
4883 else
4884 fputc(*s++, f);
4885
4886fputc('\n', f);
4887}
447d236c
PH
4888
4889
d7174846
PH
4890/*************************************************
4891* Check list of addresses for duplication *
4892*************************************************/
4893
4894/* This function was introduced when the test for duplicate addresses that are
4895not pipes, files, or autoreplies was moved from the middle of routing to when
4896routing was complete. That was to fix obscure cases when the routing history
dbcef0ea
PH
4897affects the subsequent routing of identical addresses. This function is called
4898after routing, to check that the final routed addresses are not duplicates.
d7174846 4899
dbcef0ea
PH
4900If we detect a duplicate, we remember what it is a duplicate of. Note that
4901pipe, file, and autoreply de-duplication is handled during routing, so we must
4902leave such "addresses" alone here, as otherwise they will incorrectly be
4903discarded.
d7174846
PH
4904
4905Argument: address of list anchor
4906Returns: nothing
4907*/
4908
4909static void
4910do_duplicate_check(address_item **anchor)
4911{
4912address_item *addr;
4913while ((addr = *anchor) != NULL)
4914 {
4915 tree_node *tnode;
4916 if (testflag(addr, af_pfr))
4917 {
4918 anchor = &(addr->next);
4919 }
4920 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4921 {
4922 DEBUG(D_deliver|D_route)
4923 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4924 *anchor = addr->next;
4925 addr->dupof = tnode->data.ptr;
4926 addr->next = addr_duplicate;
4927 addr_duplicate = addr;
4928 }
4929 else
4930 {
4931 tree_add_duplicate(addr->unique, addr);
4932 anchor = &(addr->next);
4933 }
4934 }
4935}
4936
4937
4938
059ec3d9
PH
4939
4940/*************************************************
4941* Deliver one message *
4942*************************************************/
4943
4944/* This is the function which is called when a message is to be delivered. It
4945is passed the id of the message. It is possible that the message no longer
4946exists, if some other process has delivered it, and it is also possible that
4947the message is being worked on by another process, in which case the data file
4948will be locked.
4949
4950If no delivery is attempted for any of the above reasons, the function returns
4951DELIVER_NOT_ATTEMPTED.
4952
4953If the give_up flag is set true, do not attempt any deliveries, but instead
4954fail all outstanding addresses and return the message to the sender (or
4955whoever).
4956
4957A delivery operation has a process all to itself; we never deliver more than
4958one message in the same process. Therefore we needn't worry too much about
4959store leakage.
4960
4961Arguments:
4962 id the id of the message to be delivered
4963 forced TRUE if delivery was forced by an administrator; this overrides
4964 retry delays and causes a delivery to be tried regardless
4965 give_up TRUE if an administrator has requested that delivery attempts
4966 be abandoned
4967
4968Returns: When the global variable mua_wrapper is FALSE:
4969 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4970 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4971 When the global variable mua_wrapper is TRUE:
4972 DELIVER_MUA_SUCCEEDED if delivery succeeded
4973 DELIVER_MUA_FAILED if delivery failed
4974 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4975*/
4976
4977int
4978deliver_message(uschar *id, BOOL forced, BOOL give_up)
4979{
4980int i, rc;
4981int final_yield = DELIVER_ATTEMPTED_NORMAL;
4982time_t now = time(NULL);
4983address_item *addr_last = NULL;
4984uschar *filter_message = NULL;
4985FILE *jread;
4986int process_recipients = RECIP_ACCEPT;
4987open_db dbblock;
4988open_db *dbm_file;
faa05a93 4989extern int acl_where;
059ec3d9
PH
4990
4991uschar *info = (queue_run_pid == (pid_t)0)?
4992 string_sprintf("delivering %s", id) :
4993 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4994
4995/* If the D_process_info bit is on, set_process_info() will output debugging
4996information. If not, we want to show this initial information if D_deliver or
4997D_queue_run is set or in verbose mode. */
4998
4999set_process_info("%s", info);
5000
5001if ((debug_selector & D_process_info) == 0 &&
5002 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
5003 debug_printf("%s\n", info);
5004
5005/* Ensure that we catch any subprocesses that are created. Although Exim
5006sets SIG_DFL as its initial default, some routes through the code end up
5007here with it set to SIG_IGN - cases where a non-synchronous delivery process
5008has been forked, but no re-exec has been done. We use sigaction rather than
5009plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5010sure it is turned off. (There was a problem on AIX with this.) */
5011
5012#ifdef SA_NOCLDWAIT
5013 {
5014 struct sigaction act;
5015 act.sa_handler = SIG_DFL;
5016 sigemptyset(&(act.sa_mask));
5017 act.sa_flags = 0;
5018 sigaction(SIGCHLD, &act, NULL);
5019 }
5020#else
5021signal(SIGCHLD, SIG_DFL);
5022#endif
5023
5024/* Make the forcing flag available for routers and transports, set up the
5025global message id field, and initialize the count for returned files and the
5026message size. This use of strcpy() is OK because the length id is checked when
5027it is obtained from a command line (the -M or -q options), and otherwise it is
5028known to be a valid message id. */
5029
5030Ustrcpy(message_id, id);
5031deliver_force = forced;
5032return_count = 0;
5033message_size = 0;
5034
5035/* Initialize some flags */
5036
5037update_spool = FALSE;
5038remove_journal = TRUE;
5039
faa05a93
JH
5040/* Set a known context for any ACLs we call via expansions */
5041acl_where = ACL_WHERE_DELIVERY;
5042
059ec3d9
PH
5043/* Reset the random number generator, so that if several delivery processes are
5044started from a queue runner that has already used random numbers (for sorting),
5045they don't all get the same sequence. */
5046
5047random_seed = 0;
5048
5049/* Open and lock the message's data file. Exim locks on this one because the
5050header file may get replaced as it is re-written during the delivery process.
5051Any failures cause messages to be written to the log, except for missing files
5052while queue running - another process probably completed delivery. As part of
5053opening the data file, message_subdir gets set. */
5054
5055if (!spool_open_datafile(id))
5056 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5057
5058/* The value of message_size at this point has been set to the data length,
5059plus one for the blank line that notionally precedes the data. */
5060
5061/* Now read the contents of the header file, which will set up the headers in
5062store, and also the list of recipients and the tree of non-recipients and
5063assorted flags. It updates message_size. If there is a reading or format error,
5064give up; if the message has been around for sufficiently long, remove it. */
5065
5066sprintf(CS spoolname, "%s-H", id);
5067if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5068 {
5069 if (errno == ERRNO_SPOOLFORMAT)
5070 {
5071 struct stat statbuf;
5072 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
5073 spoolname);
5074 if (Ustat(big_buffer, &statbuf) == 0)
b1c749bb
PH
5075 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5076 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
059ec3d9
PH
5077 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5078 }
5079 else
5080 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5081 strerror(errno));
5082
5083 /* If we managed to read the envelope data, received_time contains the
5084 time the message was received. Otherwise, we can calculate it from the
5085 message id. */
5086
5087 if (rc != spool_read_hdrerror)
5088 {
5089 received_time = 0;
5090 for (i = 0; i < 6; i++)
5091 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5092 }
5093
5094 /* If we've had this malformed message too long, sling it. */
5095
5096 if (now - received_time > keep_malformed)
5097 {
5098 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5099 Uunlink(spoolname);
5100 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
5101 Uunlink(spoolname);
5102 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
5103 Uunlink(spoolname);
5104 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5105 Uunlink(spoolname);
5106 log_write(0, LOG_MAIN, "Message removed because older than %s",
5107 readconf_printtime(keep_malformed));
5108 }
5109
f1e894f3 5110 (void)close(deliver_datafile);
059ec3d9
PH
5111 deliver_datafile = -1;
5112 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5113 }
5114
5115/* The spool header file has been read. Look to see if there is an existing
5116journal file for this message. If there is, it means that a previous delivery
5117attempt crashed (program or host) before it could update the spool header file.
5118Read the list of delivered addresses from the journal and add them to the
5119nonrecipients tree. Then update the spool file. We can leave the journal in
5120existence, as it will get further successful deliveries added to it in this
5121run, and it will be deleted if this function gets to its end successfully.
5122Otherwise it might be needed again. */
5123
5124sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5125jread = Ufopen(spoolname, "rb");
5126if (jread != NULL)
5127 {
5128 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
5129 {
5130 int n = Ustrlen(big_buffer);
5131 big_buffer[n-1] = 0;
5132 tree_add_nonrecipient(big_buffer);
5133 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5134 "journal file\n", big_buffer);
5135 }
f1e894f3 5136 (void)fclose(jread);
059ec3d9
PH
5137 /* Panic-dies on error */
5138 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5139 }
5140else if (errno != ENOENT)
5141 {
5142 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5143 "%s", strerror(errno));
5144 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5145 }
5146
5147/* A null recipients list indicates some kind of disaster. */
5148
5149if (recipients_list == NULL)
5150 {
f1e894f3 5151 (void)close(deliver_datafile);
059ec3d9
PH
5152 deliver_datafile = -1;
5153 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
5154 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5155 }
5156
5157
5158/* Handle a message that is frozen. There are a number of different things that
5159can happen, but in the default situation, unless forced, no delivery is
5160attempted. */
5161
5162if (deliver_freeze)
5163 {
a7538db1 5164#ifdef SUPPORT_MOVE_FROZEN_MESSAGES
059ec3d9
PH
5165 /* Moving to another directory removes the message from Exim's view. Other
5166 tools must be used to deal with it. Logging of this action happens in
5167 spool_move_message() and its subfunctions. */
5168
5169 if (move_frozen_messages &&
5170 spool_move_message(id, message_subdir, US"", US"F"))
5171 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
a7538db1 5172#endif
059ec3d9
PH
5173
5174 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5175 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5176 flag causing all recipients to be failed. The time is the age of the
5177 message, not the time since freezing. */
5178
5179 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5180 {
5181 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5182 process_recipients = RECIP_FAIL_TIMEOUT;
5183 }
5184
5185 /* For bounce messages (and others with no sender), thaw if the error message
5186 ignore timer is exceeded. The message will be discarded if this delivery
5187 fails. */
5188
5189 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5190 {
5191 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5192 }
5193
ef213c3b
PH
5194 /* If this is a bounce message, or there's no auto thaw, or we haven't
5195 reached the auto thaw time yet, and this delivery is not forced by an admin
5196 user, do not attempt delivery of this message. Note that forced is set for
5197 continuing messages down the same channel, in order to skip load checking and
5198 ignore hold domains, but we don't want unfreezing in that case. */
059ec3d9
PH
5199
5200 else
5201 {
ef213c3b
PH
5202 if ((sender_address[0] == 0 ||
5203 auto_thaw <= 0 ||
5204 now <= deliver_frozen_at + auto_thaw
5205 )
5206 &&
5207 (!forced || !deliver_force_thaw || !admin_user ||
5208 continue_hostname != NULL
5209 ))
059ec3d9 5210 {
f1e894f3 5211 (void)close(deliver_datafile);
059ec3d9
PH
5212 deliver_datafile = -1;
5213 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5214 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5215 }
5216
5217 /* If delivery was forced (by an admin user), assume a manual thaw.
5218 Otherwise it's an auto thaw. */
5219
5220 if (forced)
5221 {
5222 deliver_manual_thaw = TRUE;
5223 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5224 }
5225 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5226 }
5227
5228 /* We get here if any of the rules for unfreezing have triggered. */
5229
5230 deliver_freeze = FALSE;
5231 update_spool = TRUE;
5232 }
5233
5234
5235/* Open the message log file if we are using them. This records details of
5236deliveries, deferments, and failures for the benefit of the mail administrator.
5237The log is not used by exim itself to track the progress of a message; that is
5238done by rewriting the header spool file. */
5239
5240if (message_logs)
5241 {
5242 uschar *error;
5243 int fd;
5244
5245 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5246 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5247
5248 if (fd < 0)
5249 {
5250 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5251 spoolname, strerror(errno));
5252 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5253 }
5254
5255 /* Make a C stream out of it. */
5256
5257 message_log = fdopen(fd, "a");
5258 if (message_log == NULL)
5259 {
5260 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5261 spoolname, strerror(errno));
5262 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5263 }
5264 }
5265
5266
5267/* If asked to give up on a message, log who did it, and set the action for all
5268the addresses. */
5269
5270if (give_up)
5271 {
5272 struct passwd *pw = getpwuid(real_uid);
5273 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
5274 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5275 process_recipients = RECIP_FAIL;
5276 }
5277
5278/* Otherwise, if there are too many Received: headers, fail all recipients. */
5279
5280else if (received_count > received_headers_max)
5281 process_recipients = RECIP_FAIL_LOOP;
5282
5283/* Otherwise, if a system-wide, address-independent message filter is
5284specified, run it now, except in the case when we are failing all recipients as
5285a result of timeout_frozen_after. If the system filter yields "delivered", then
5286ignore the true recipients of the message. Failure of the filter file is
5287logged, and the delivery attempt fails. */
5288
5289else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
5290 {
5291 int rc;
5292 int filtertype;
5293 ugid_block ugid;
5294 redirect_block redirect;
5295
5296 if (system_filter_uid_set)
5297 {
5298 ugid.uid = system_filter_uid;
5299 ugid.gid = system_filter_gid;
5300 ugid.uid_set = ugid.gid_set = TRUE;
5301 }
5302 else
5303 {
5304 ugid.uid_set = ugid.gid_set = FALSE;
5305 }
5306
5307 return_path = sender_address;
5308 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5309 system_filtering = TRUE;
5310
5311 /* Any error in the filter file causes a delivery to be abandoned. */
5312
5313 redirect.string = system_filter;
5314 redirect.isfile = TRUE;
5315 redirect.check_owner = redirect.check_group = FALSE;
5316 redirect.owners = NULL;
5317 redirect.owngroups = NULL;
5318 redirect.pw = NULL;
5319 redirect.modemask = 0;
5320
5321 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5322
5323 rc = rda_interpret(
5324 &redirect, /* Where the data is */
5325 RDO_DEFER | /* Turn on all the enabling options */
5326 RDO_FAIL | /* Leave off all the disabling options */
5327 RDO_FILTER |
5328 RDO_FREEZE |
5329 RDO_REALLOG |
5330 RDO_REWRITE,
5331 NULL, /* No :include: restriction (not used in filter) */
5332 NULL, /* No sieve vacation directory (not sieve!) */
efd9a422 5333 NULL, /* No sieve enotify mailto owner (not sieve!) */
e4a89c47
PH
5334 NULL, /* No sieve user address (not sieve!) */
5335 NULL, /* No sieve subaddress (not sieve!) */
059ec3d9
PH
5336 &ugid, /* uid/gid data */
5337 &addr_new, /* Where to hang generated addresses */
5338 &filter_message, /* Where to put error message */
5339 NULL, /* Don't skip syntax errors */
5340 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5341 US"system filter"); /* For error messages */
5342
5343 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5344
5345 if (rc == FF_ERROR || rc == FF_NONEXIST)
5346 {
f1e894f3 5347 (void)close(deliver_datafile);
059ec3d9
PH
5348 deliver_datafile = -1;
5349 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5350 string_printing(filter_message));
5351 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5352 }
5353
5354 /* Reset things. If the filter message is an empty string, which can happen
5355 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5356
5357 system_filtering = FALSE;
5358 enable_dollar_recipients = FALSE;
5359 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5360
5361 /* Save the values of the system filter variables so that user filters
5362 can use them. */
5363
5364 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5365
5366 /* The filter can request that delivery of the original addresses be
5367 deferred. */
5368
5369 if (rc == FF_DEFER)
5370 {
5371 process_recipients = RECIP_DEFER;
5372 deliver_msglog("Delivery deferred by system filter\n");
5373 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5374 }
5375
5376 /* The filter can request that a message be frozen, but this does not
5377 take place if the message has been manually thawed. In that case, we must
5378 unset "delivered", which is forced by the "freeze" command to make -bF
5379 work properly. */
5380
5381 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5382 {
5383 deliver_freeze = TRUE;
5384 deliver_frozen_at = time(NULL);
5385 process_recipients = RECIP_DEFER;
5386 frozen_info = string_sprintf(" by the system filter%s%s",
5387 (filter_message == NULL)? US"" : US": ",
5388 (filter_message == NULL)? US"" : filter_message);
5389 }
5390
5391 /* The filter can request that a message be failed. The error message may be
5392 quite long - it is sent back to the sender in the bounce - but we don't want
5393 to fill up the log with repetitions of it. If it starts with << then the text
5394 between << and >> is written to the log, with the rest left for the bounce
5395 message. */
5396
5397 else if (rc == FF_FAIL)
5398 {
5399 uschar *colon = US"";
5400 uschar *logmsg = US"";
5401 int loglen = 0;
5402
5403 process_recipients = RECIP_FAIL_FILTER;
5404
5405 if (filter_message != NULL)
5406 {
5407 uschar *logend;
5408 colon = US": ";
5409 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5410 (logend = Ustrstr(filter_message, ">>")) != NULL)
5411 {
5412 logmsg = filter_message + 2;
5413 loglen = logend - logmsg;
5414 filter_message = logend + 2;
5415 if (filter_message[0] == 0) filter_message = NULL;
5416 }
5417 else
5418 {
5419 logmsg = filter_message;
5420 loglen = Ustrlen(filter_message);
5421 }
5422 }
5423
5424 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5425 logmsg);
5426 }
5427
5428 /* Delivery can be restricted only to those recipients (if any) that the
5429 filter specified. */
5430
5431 else if (rc == FF_DELIVERED)
5432 {
5433 process_recipients = RECIP_IGNORE;
5434 if (addr_new == NULL)
5435 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5436 else
5437 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5438 }
5439
5440 /* If any new addresses were created by the filter, fake up a "parent"
5441 for them. This is necessary for pipes, etc., which are expected to have
5442 parents, and it also gives some sensible logging for others. Allow
5443 pipes, files, and autoreplies, and run them as the filter uid if set,
5444 otherwise as the current uid. */
5445
5446 if (addr_new != NULL)
5447 {
5448 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5449 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5450
5451 /* The text "system-filter" is tested in transport_set_up_command() and in
5452 set_up_shell_command() in the pipe transport, to enable them to permit
5453 $recipients, so don't change it here without also changing it there. */
5454
5455 address_item *p = addr_new;
5456 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5457
5458 parent->domain = string_copylc(qualify_domain_recipient);
5459 parent->local_part = US"system-filter";
5460
5461 /* As part of this loop, we arrange for addr_last to end up pointing
5462 at the final address. This is used if we go on to add addresses for the
5463 original recipients. */
5464
5465 while (p != NULL)
5466 {
4362ff0d
PH
5467 if (parent->child_count == SHRT_MAX)
5468 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5469 "than %d delivery addresses", SHRT_MAX);
059ec3d9
PH
5470 parent->child_count++;
5471 p->parent = parent;
5472
5473 if (testflag(p, af_pfr))
5474 {
5475 uschar *tpname;
5476 uschar *type;
5477 p->uid = uid;
5478 p->gid = gid;
5479 setflag(p, af_uid_set |
5480 af_gid_set |
5481 af_allow_file |
5482 af_allow_pipe |
5483 af_allow_reply);
5484
5485 /* Find the name of the system filter's appropriate pfr transport */
5486
5487 if (p->address[0] == '|')
5488 {
5489 type = US"pipe";
5490 tpname = system_filter_pipe_transport;
5491 address_pipe = p->address;
5492 }
5493 else if (p->address[0] == '>')
5494 {
5495 type = US"reply";
5496 tpname = system_filter_reply_transport;
5497 }
5498 else
5499 {
5500 if (p->address[Ustrlen(p->address)-1] == '/')
5501 {
5502 type = US"directory";
5503 tpname = system_filter_directory_transport;
5504 }
5505 else
5506 {
5507 type = US"file";
5508 tpname = system_filter_file_transport;
5509 }
5510 address_file = p->address;
5511 }
5512
5513 /* Now find the actual transport, first expanding the name. We have
5514 set address_file or address_pipe above. */
5515
5516 if (tpname != NULL)
5517 {
5518 uschar *tmp = expand_string(tpname);
5519 address_file = address_pipe = NULL;
5520 if (tmp == NULL)
5521 p->message = string_sprintf("failed to expand \"%s\" as a "
5522 "system filter transport name", tpname);
5523 tpname = tmp;
5524 }
5525 else
5526 {
5527 p->message = string_sprintf("system_filter_%s_transport is unset",
5528 type);
5529 }
5530
5531 if (tpname != NULL)
5532 {
5533 transport_instance *tp;
5534 for (tp = transports; tp != NULL; tp = tp->next)
5535 {
5536 if (Ustrcmp(tp->name, tpname) == 0)
5537 {
5538 p->transport = tp;
5539 break;
5540 }
5541 }
5542 if (tp == NULL)
5543 p->message = string_sprintf("failed to find \"%s\" transport "
5544 "for system filter delivery", tpname);
5545 }
5546
5547 /* If we couldn't set up a transport, defer the delivery, putting the
5548 error on the panic log as well as the main log. */
5549
5550 if (p->transport == NULL)
5551 {
5552 address_item *badp = p;
5553 p = p->next;
5554 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5555 badp->local_part = badp->address; /* Needed for log line */
5556 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5557 continue;
5558 }
5559 } /* End of pfr handling */
5560
5561 /* Either a non-pfr delivery, or we found a transport */
5562
5563 DEBUG(D_deliver|D_filter)
5564 debug_printf("system filter added %s\n", p->address);
5565
5566 addr_last = p;
5567 p = p->next;
5568 } /* Loop through all addr_new addresses */
5569 }
5570 }
5571
5572
5573/* Scan the recipients list, and for every one that is not in the non-
5574recipients tree, add an addr item to the chain of new addresses. If the pno
5575value is non-negative, we must set the onetime parent from it. This which
5576points to the relevant entry in the recipients list.
5577
5578This processing can be altered by the setting of the process_recipients
5579variable, which is changed if recipients are to be ignored, failed, or
5580deferred. This can happen as a result of system filter activity, or if the -Mg
5581option is used to fail all of them.
5582
5583Duplicate addresses are handled later by a different tree structure; we can't
5584just extend the non-recipients tree, because that will be re-written to the
5585spool if the message is deferred, and in any case there are casing
5586complications for local addresses. */
5587
5588if (process_recipients != RECIP_IGNORE)
5589 {
5590 for (i = 0; i < recipients_count; i++)
5591 {
5592 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5593 {
5594 recipient_item *r = recipients_list + i;
5595 address_item *new = deliver_make_addr(r->address, FALSE);
d43cbe25 5596 new->prop.errors_address = r->errors_to;
7ade712c 5597#ifdef EXPERIMENTAL_INTERNATIONAL
d43cbe25 5598 new->prop.utf8 = message_smtputf8;
7ade712c
JH
5599 DEBUG(D_deliver) debug_printf("utf8: %c\n", message_smtputf8 ? 'T':'F');
5600#endif
059ec3d9
PH
5601
5602 if (r->pno >= 0)
5603 new->onetime_parent = recipients_list[r->pno].address;
5604
6c1c3d1d
WB
5605 /* If DSN support is enabled, set the dsn flags and the original receipt
5606 to be passed on to other DSN enabled MTAs */
5607 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5608 new->dsn_orcpt = r->orcpt;
5609 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n", new->dsn_orcpt, new->dsn_flags);
6c1c3d1d 5610
059ec3d9
PH
5611 switch (process_recipients)
5612 {
5613 /* RECIP_DEFER is set when a system filter freezes a message. */
5614
5615 case RECIP_DEFER:
5616 new->next = addr_defer;
5617 addr_defer = new;
5618 break;
5619
5620
5621 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5622 command. */
5623
5624 case RECIP_FAIL_FILTER:
5625 new->message =
5626 (filter_message == NULL)? US"delivery cancelled" : filter_message;
447d236c 5627 setflag(new, af_pass_message);
059ec3d9
PH
5628 goto RECIP_QUEUE_FAILED; /* below */
5629
5630
5631 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5632 than the value in timeout_frozen_after. Treat non-bounce messages
5633 similarly to -Mg; for bounce messages we just want to discard, so
5634 don't put the address on the failed list. The timeout has already
5635 been logged. */
5636
5637 case RECIP_FAIL_TIMEOUT:
5638 new->message = US"delivery cancelled; message timed out";
5639 goto RECIP_QUEUE_FAILED; /* below */
5640
5641
5642 /* RECIP_FAIL is set when -Mg has been used. */
5643
5644 case RECIP_FAIL:
5645 new->message = US"delivery cancelled by administrator";
5646 /* Fall through */
5647
5648 /* Common code for the failure cases above. If this is not a bounce
5649 message, put the address on the failed list so that it is used to
5650 create a bounce. Otherwise do nothing - this just discards the address.
5651 The incident has already been logged. */
5652
5653 RECIP_QUEUE_FAILED:
5654 if (sender_address[0] != 0)
5655 {
5656 new->next = addr_failed;
5657 addr_failed = new;
5658 }
5659 break;
5660
5661
5662 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5663 in the message. Process each address as a routing failure; if this
5664 is a bounce message, it will get frozen. */
5665
5666 case RECIP_FAIL_LOOP:
5667 new->message = US"Too many \"Received\" headers - suspected mail loop";
5668 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5669 break;
5670
5671
5672 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5673
5674 default:
5675 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5676 addr_last = new;
5677 break;
5678 }
14a465c3 5679
774ef2d7 5680#ifdef EXPERIMENTAL_EVENT
14a465c3
JH
5681 if (process_recipients != RECIP_ACCEPT)
5682 {
5683 uschar * save_local = deliver_localpart;
55414b25 5684 const uschar * save_domain = deliver_domain;
14a465c3
JH
5685
5686 deliver_localpart = expand_string(
5687 string_sprintf("${local_part:%s}", new->address));
5688 deliver_domain = expand_string(
5689 string_sprintf("${domain:%s}", new->address));
5690
774ef2d7 5691 (void) event_raise(event_action,
14a465c3
JH
5692 US"msg:fail:internal", new->message);
5693
5694 deliver_localpart = save_local;
5695 deliver_domain = save_domain;
5696 }
5697#endif
059ec3d9
PH
5698 }
5699 }
5700 }
5701
5702DEBUG(D_deliver)
5703 {
5704 address_item *p = addr_new;
5705 debug_printf("Delivery address list:\n");
5706 while (p != NULL)
5707 {
5708 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5709 p->onetime_parent);
5710 p = p->next;
5711 }
5712 }
5713
5714/* Set up the buffers used for copying over the file when delivering. */
5715
5716deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5717deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5718
5719
5720
5721/* Until there are no more new addresses, handle each one as follows:
5722
5723 . If this is a generated address (indicated by the presence of a parent
5724 pointer) then check to see whether it is a pipe, file, or autoreply, and
5725 if so, handle it directly here. The router that produced the address will
5726 have set the allow flags into the address, and also set the uid/gid required.
5727 Having the routers generate new addresses and then checking them here at
5728 the outer level is tidier than making each router do the checking, and
5729 means that routers don't need access to the failed address queue.
5730
5731 . Break up the address into local part and domain, and make lowercased
5732 versions of these strings. We also make unquoted versions of the local part.
5733
5734 . Handle the percent hack for those domains for which it is valid.
5735
5736 . For child addresses, determine if any of the parents have the same address.
5737 If so, generate a different string for previous delivery checking. Without
5738 this code, if the address spqr generates spqr via a forward or alias file,
5739 delivery of the generated spqr stops further attempts at the top level spqr,
5740 which is not what is wanted - it may have generated other addresses.
5741
5742 . Check on the retry database to see if routing was previously deferred, but
5743 only if in a queue run. Addresses that are to be routed are put on the
5744 addr_route chain. Addresses that are to be deferred are put on the
5745 addr_defer chain. We do all the checking first, so as not to keep the
5746 retry database open any longer than necessary.
5747
5748 . Now we run the addresses through the routers. A router may put the address
5749 on either the addr_local or the addr_remote chain for local or remote
5750 delivery, respectively, or put it on the addr_failed chain if it is
5751 undeliveable, or it may generate child addresses and put them on the
5752 addr_new chain, or it may defer an address. All the chain anchors are
5753 passed as arguments so that the routers can be called for verification
5754 purposes as well.
5755
5756 . If new addresses have been generated by the routers, da capo.
5757*/
5758
5759header_rewritten = FALSE; /* No headers rewritten yet */
5760while (addr_new != NULL) /* Loop until all addresses dealt with */
5761 {
5762 address_item *addr, *parent;
5763 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5764
5765 /* Failure to open the retry database is treated the same as if it does
5766 not exist. In both cases, dbm_file is NULL. */
5767
5768 if (dbm_file == NULL)
5769 {
5770 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5771 debug_printf("no retry data available\n");
5772 }
5773
5774 /* Scan the current batch of new addresses, to handle pipes, files and
5775 autoreplies, and determine which others are ready for routing. */
5776
5777 while (addr_new != NULL)
5778 {
5779 int rc;
5780 uschar *p;
5781 tree_node *tnode;
5782 dbdata_retry *domain_retry_record;
5783 dbdata_retry *address_retry_record;
5784
5785 addr = addr_new;
5786 addr_new = addr->next;
5787
5788 DEBUG(D_deliver|D_retry|D_route)
5789 {
5790 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5791 debug_printf("Considering: %s\n", addr->address);
5792 }
5793
5794 /* Handle generated address that is a pipe or a file or an autoreply. */
5795
5796 if (testflag(addr, af_pfr))
5797 {
424a1c63
PH
5798 /* If an autoreply in a filter could not generate a syntactically valid
5799 address, give up forthwith. Set af_ignore_error so that we don't try to
5800 generate a bounce. */
5801
5802 if (testflag(addr, af_bad_reply))
5803 {
5804 addr->basic_errno = ERRNO_BADADDRESS2;
5805 addr->local_part = addr->address;
5806 addr->message =
5807 US"filter autoreply generated syntactically invalid recipient";
5808 setflag(addr, af_ignore_error);
5809 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5810 continue; /* with the next new address */
5811 }
059ec3d9
PH
5812
5813 /* If two different users specify delivery to the same pipe or file or
5814 autoreply, there should be two different deliveries, so build a unique
5815 string that incorporates the original address, and use this for
5816 duplicate testing and recording delivery, and also for retrying. */
5817
5818 addr->unique =
424a1c63
PH
5819 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5820 (testflag(addr->parent, af_homonym)? 3:0));
059ec3d9
PH
5821
5822 addr->address_retry_key = addr->domain_retry_key =
5823 string_sprintf("T:%s", addr->unique);
5824
5825 /* If a filter file specifies two deliveries to the same pipe or file,
5826 we want to de-duplicate, but this is probably not wanted for two mail
5827 commands to the same address, where probably both should be delivered.
5828 So, we have to invent a different unique string in that case. Just
5829 keep piling '>' characters on the front. */
5830
5831 if (addr->address[0] == '>')
5832 {
5833 while (tree_search(tree_duplicates, addr->unique) != NULL)
5834 addr->unique = string_sprintf(">%s", addr->unique);
5835 }
5836
5837 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5838 {
5839 DEBUG(D_deliver|D_route)
5840 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5841 addr->dupof = tnode->data.ptr;
5842 addr->next = addr_duplicate;
5843 addr_duplicate = addr;
5844 continue;
5845 }
5846
5847 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5848
5849 /* Check for previous delivery */
5850
5851 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5852 {
5853 DEBUG(D_deliver|D_route)
5854 debug_printf("%s was previously delivered: discarded\n", addr->address);
5855 child_done(addr, tod_stamp(tod_log));
5856 continue;
5857 }
5858
5859 /* Save for checking future duplicates */
5860
5861 tree_add_duplicate(addr->unique, addr);
5862
5863 /* Set local part and domain */
5864
5865 addr->local_part = addr->address;
5866 addr->domain = addr->parent->domain;
5867
5868 /* Ensure that the delivery is permitted. */
5869
5870 if (testflag(addr, af_file))
5871 {
5872 if (!testflag(addr, af_allow_file))
5873 {
5874 addr->basic_errno = ERRNO_FORBIDFILE;
5875 addr->message = US"delivery to file forbidden";
5876 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5877 continue; /* with the next new address */
5878 }
5879 }
5880 else if (addr->address[0] == '|')
5881 {
5882 if (!testflag(addr, af_allow_pipe))
5883 {
5884 addr->basic_errno = ERRNO_FORBIDPIPE;
5885 addr->message = US"delivery to pipe forbidden";
5886 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5887 continue; /* with the next new address */
5888 }
5889 }
5890 else if (!testflag(addr, af_allow_reply))
5891 {
5892 addr->basic_errno = ERRNO_FORBIDREPLY;
5893 addr->message = US"autoreply forbidden";
5894 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5895 continue; /* with the next new address */
5896 }
5897
5898 /* If the errno field is already set to BADTRANSPORT, it indicates
5899 failure to expand a transport string, or find the associated transport,
5900 or an unset transport when one is required. Leave this test till now so
5901 that the forbid errors are given in preference. */
5902
5903 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5904 {
5905 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5906 continue;
5907 }
5908
5909 /* Treat /dev/null as a special case and abandon the delivery. This
5910 avoids having to specify a uid on the transport just for this case.
5911 Arrange for the transport name to be logged as "**bypassed**". */
5912
5913 if (Ustrcmp(addr->address, "/dev/null") == 0)
5914 {
5915 uschar *save = addr->transport->name;
5916 addr->transport->name = US"**bypassed**";
5917 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5918 addr->transport->name = save;
5919 continue; /* with the next new address */
5920 }
5921
5922 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5923 delivery. */
5924
5925 DEBUG(D_deliver|D_route)
5926 debug_printf("queued for %s transport\n", addr->transport->name);
5927 addr->next = addr_local;
5928 addr_local = addr;
5929 continue; /* with the next new address */
5930 }
5931
5932 /* Handle normal addresses. First, split up into local part and domain,
5933 handling the %-hack if necessary. There is the possibility of a defer from
5934 a lookup in percent_hack_domains. */
5935
5936 if ((rc = deliver_split_address(addr)) == DEFER)
5937 {
5938 addr->message = US"cannot check percent_hack_domains";
5939 addr->basic_errno = ERRNO_LISTDEFER;
5940 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5941 continue;
5942 }
5943
5944 /* Check to see if the domain is held. If so, proceed only if the
5945 delivery was forced by hand. */
5946
5947 deliver_domain = addr->domain; /* set $domain */
5948 if (!forced && hold_domains != NULL &&
55414b25 5949 (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
059ec3d9
PH
5950 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5951 NULL)) != FAIL)
5952 {
5953 if (rc == DEFER)
5954 {
5955 addr->message = US"hold_domains lookup deferred";
5956 addr->basic_errno = ERRNO_LISTDEFER;
5957 }
5958 else
5959 {
5960 addr->message = US"domain is held";
5961 addr->basic_errno = ERRNO_HELD;
5962 }
5963 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5964 continue;
5965 }
5966
5967 /* Now we can check for duplicates and previously delivered addresses. In
5968 order to do this, we have to generate a "unique" value for each address,
5969 because there may be identical actual addresses in a line of descendents.
5970 The "unique" field is initialized to the same value as the "address" field,
5971 but gets changed here to cope with identically-named descendents. */
5972
5973 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5974 if (strcmpic(addr->address, parent->address) == 0) break;
5975
5976 /* If there's an ancestor with the same name, set the homonym flag. This
5977 influences how deliveries are recorded. Then add a prefix on the front of
5978 the unique address. We use \n\ where n starts at 0 and increases each time.
5979 It is unlikely to pass 9, but if it does, it may look odd but will still
5980 work. This means that siblings or cousins with the same names are treated
5981 as duplicates, which is what we want. */
5982
5983 if (parent != NULL)
5984 {
5985 setflag(addr, af_homonym);
5986 if (parent->unique[0] != '\\')
5987 addr->unique = string_sprintf("\\0\\%s", addr->address);
5988 else
5989 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5990 addr->address);
5991 }
5992
5993 /* Ensure that the domain in the unique field is lower cased, because
5994 domains are always handled caselessly. */
5995
5996 p = Ustrrchr(addr->unique, '@');
5997 while (*p != 0) { *p = tolower(*p); p++; }
5998
5999 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6000
6001 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
6002 {
6003 DEBUG(D_deliver|D_route)
6004 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6005 child_done(addr, tod_stamp(tod_log));
6006 continue;
6007 }
6008
059ec3d9 6009 /* Get the routing retry status, saving the two retry keys (with and
48c7f9e2
PH
6010 without the local part) for subsequent use. If there is no retry record for
6011 the standard address routing retry key, we look for the same key with the
6012 sender attached, because this form is used by the smtp transport after a
6013 4xx response to RCPT when address_retry_include_sender is true. */
059ec3d9
PH
6014
6015 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6016 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6017 addr->domain);
6018
6019 if (dbm_file == NULL)
6020 domain_retry_record = address_retry_record = NULL;
6021 else
6022 {
6023 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6024 if (domain_retry_record != NULL &&
6025 now - domain_retry_record->time_stamp > retry_data_expire)
48c7f9e2 6026 domain_retry_record = NULL; /* Ignore if too old */
059ec3d9
PH
6027
6028 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6029 if (address_retry_record != NULL &&
6030 now - address_retry_record->time_stamp > retry_data_expire)
48c7f9e2
PH
6031 address_retry_record = NULL; /* Ignore if too old */
6032
6033 if (address_retry_record == NULL)
6034 {
09945f1e 6035 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
48c7f9e2
PH
6036 sender_address);
6037 address_retry_record = dbfn_read(dbm_file, altkey);
6038 if (address_retry_record != NULL &&
6039 now - address_retry_record->time_stamp > retry_data_expire)
6040 address_retry_record = NULL; /* Ignore if too old */
6041 }
059ec3d9
PH
6042 }
6043
6044 DEBUG(D_deliver|D_retry)
6045 {
6046 if (domain_retry_record == NULL)
6047 debug_printf("no domain retry record\n");
6048 if (address_retry_record == NULL)
6049 debug_printf("no address retry record\n");
6050 }
6051
6052 /* If we are sending a message down an existing SMTP connection, we must
6053 assume that the message which created the connection managed to route
6054 an address to that connection. We do not want to run the risk of taking
6055 a long time over routing here, because if we do, the server at the other
6056 end of the connection may time it out. This is especially true for messages
6057 with lots of addresses. For this kind of delivery, queue_running is not
6058 set, so we would normally route all addresses. We take a pragmatic approach
6059 and defer routing any addresses that have any kind of domain retry record.
6060 That is, we don't even look at their retry times. It doesn't matter if this
6061 doesn't work occasionally. This is all just an optimization, after all.
6062
6063 The reason for not doing the same for address retries is that they normally
6064 arise from 4xx responses, not DNS timeouts. */
6065
6066 if (continue_hostname != NULL && domain_retry_record != NULL)
6067 {
6068 addr->message = US"reusing SMTP connection skips previous routing defer";
6069 addr->basic_errno = ERRNO_RRETRY;
6070 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6071 }
6072
f6c332bd
PH
6073 /* If we are in a queue run, defer routing unless there is no retry data or
6074 we've passed the next retry time, or this message is forced. In other
6075 words, ignore retry data when not in a queue run.
6076
6077 However, if the domain retry time has expired, always allow the routing
6078 attempt. If it fails again, the address will be failed. This ensures that
059ec3d9
PH
6079 each address is routed at least once, even after long-term routing
6080 failures.
6081
6082 If there is an address retry, check that too; just wait for the next
6083 retry time. This helps with the case when the temporary error on the
6084 address was really message-specific rather than address specific, since
f6c332bd
PH
6085 it allows other messages through.
6086
6087 We also wait for the next retry time if this is a message sent down an
6088 existing SMTP connection (even though that will be forced). Otherwise there
6089 will be far too many attempts for an address that gets a 4xx error. In
6090 fact, after such an error, we should not get here because, the host should
6091 not be remembered as one this message needs. However, there was a bug that
ba9af0af
TF
6092 used to cause this to happen, so it is best to be on the safe side.
6093
1ddeb334
TF
6094 Even if we haven't reached the retry time in the hints, there is one more
6095 check to do, which is for the ultimate address timeout. We only do this
6096 check if there is an address retry record and there is not a domain retry
6097 record; this implies that previous attempts to handle the address had the
6098 retry_use_local_parts option turned on. We use this as an approximation
6099 for the destination being like a local delivery, for example delivery over
6100 LMTP to an IMAP message store. In this situation users are liable to bump
6101 into their quota and thereby have intermittently successful deliveries,
6102 which keep the retry record fresh, which can lead to us perpetually
6103 deferring messages. */
059ec3d9 6104
f6c332bd
PH
6105 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
6106 &&
059ec3d9
PH
6107 ((domain_retry_record != NULL &&
6108 now < domain_retry_record->next_try &&
6109 !domain_retry_record->expired)
6110 ||
6111 (address_retry_record != NULL &&
6112 now < address_retry_record->next_try))
ba9af0af 6113 &&
1ddeb334
TF
6114 (domain_retry_record != NULL ||
6115 address_retry_record == NULL ||
6116 !retry_ultimate_address_timeout(addr->address_retry_key,
6117 addr->domain, address_retry_record, now)))
059ec3d9
PH
6118 {
6119 addr->message = US"retry time not reached";
6120 addr->basic_errno = ERRNO_RRETRY;
6121 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6122 }
6123
6124 /* The domain is OK for routing. Remember if retry data exists so it
6125 can be cleaned up after a successful delivery. */
6126
6127 else
6128 {
6129 if (domain_retry_record != NULL || address_retry_record != NULL)
6130 setflag(addr, af_dr_retry_exists);
6131 addr->next = addr_route;
6132 addr_route = addr;
6133 DEBUG(D_deliver|D_route)
6134 debug_printf("%s: queued for routing\n", addr->address);
6135 }
6136 }
6137
6138 /* The database is closed while routing is actually happening. Requests to
6139 update it are put on a chain and all processed together at the end. */
6140
6141 if (dbm_file != NULL) dbfn_close(dbm_file);
6142
6143 /* If queue_domains is set, we don't even want to try routing addresses in
6144 those domains. During queue runs, queue_domains is forced to be unset.
6145 Optimize by skipping this pass through the addresses if nothing is set. */
6146
6147 if (!deliver_force && queue_domains != NULL)
6148 {
6149 address_item *okaddr = NULL;
6150 while (addr_route != NULL)
6151 {
6152 address_item *addr = addr_route;
6153 addr_route = addr->next;
6154
6155 deliver_domain = addr->domain; /* set $domain */
55414b25 6156 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
059ec3d9
PH
6157 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6158 != OK)
6159 {
6160 if (rc == DEFER)
6161 {
6162 addr->basic_errno = ERRNO_LISTDEFER;
6163 addr->message = US"queue_domains lookup deferred";
6164 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6165 }
6166 else
6167 {
6168 addr->next = okaddr;
6169 okaddr = addr;
6170 }
6171 }
6172 else
6173 {
6174 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6175 addr->message = US"domain is in queue_domains";
6176 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6177 }
6178 }
6179
6180 addr_route = okaddr;
6181 }
6182
6183 /* Now route those addresses that are not deferred. */
6184
6185 while (addr_route != NULL)
6186 {
6187 int rc;
6188 address_item *addr = addr_route;
55414b25 6189 const uschar *old_domain = addr->domain;
059ec3d9
PH
6190 uschar *old_unique = addr->unique;
6191 addr_route = addr->next;
6192 addr->next = NULL;
6193
6194 /* Just in case some router parameter refers to it. */
6195
d43cbe25
JH
6196 return_path = (addr->prop.errors_address != NULL)?
6197 addr->prop.errors_address : sender_address;
059ec3d9
PH
6198
6199 /* If a router defers an address, add a retry item. Whether or not to
6200 use the local part in the key is a property of the router. */
6201
6202 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6203 &addr_succeed, v_none)) == DEFER)
6204 retry_add_item(addr, (addr->router->retry_use_local_part)?
6205 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
6206 string_sprintf("R:%s", addr->domain), 0);
6207
6208 /* Otherwise, if there is an existing retry record in the database, add
09945f1e
PH
6209 retry items to delete both forms. We must also allow for the possibility
6210 of a routing retry that includes the sender address. Since the domain might
6211 have been rewritten (expanded to fully qualified) as a result of routing,
6212 ensure that the rewritten form is also deleted. */
059ec3d9
PH
6213
6214 else if (testflag(addr, af_dr_retry_exists))
6215 {
09945f1e
PH
6216 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6217 sender_address);
6218 retry_add_item(addr, altkey, rf_delete);
059ec3d9
PH
6219 retry_add_item(addr, addr->address_retry_key, rf_delete);
6220 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6221 if (Ustrcmp(addr->domain, old_domain) != 0)
6222 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6223 }
6224
6225 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6226 logged, but we need to ensure the address (and maybe parents) is marked
6227 done. */
6228
6229 if (rc == DISCARD)
6230 {
6231 address_done(addr, tod_stamp(tod_log));
6232 continue; /* route next address */
6233 }
6234
6235 /* The address is finished with (failed or deferred). */
6236
6237 if (rc != OK)
6238 {
6239 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6240 continue; /* route next address */
6241 }
6242
6243 /* The address has been routed. If the router changed the domain, it will
6244 also have changed the unique address. We have to test whether this address
6245 has already been delivered, because it's the unique address that finally
6246 gets recorded. */
6247
6248 if (addr->unique != old_unique &&
6249 tree_search(tree_nonrecipients, addr->unique) != 0)
6250 {
6251 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6252 "discarded\n", addr->address);
6253 if (addr_remote == addr) addr_remote = addr->next;
6254 else if (addr_local == addr) addr_local = addr->next;
6255 }
6256
6257 /* If the router has same_domain_copy_routing set, we are permitted to copy
6258 the routing for any other addresses with the same domain. This is an
6259 optimisation to save repeated DNS lookups for "standard" remote domain
6260 routing. The option is settable only on routers that generate host lists.
6261 We play it very safe, and do the optimization only if the address is routed
6262 to a remote transport, there are no header changes, and the domain was not
6263 modified by the router. */
6264
6265 if (addr_remote == addr &&
6266 addr->router->same_domain_copy_routing &&
d43cbe25
JH
6267 addr->prop.extra_headers == NULL &&
6268 addr->prop.remove_headers == NULL &&
059ec3d9
PH
6269 old_domain == addr->domain)
6270 {
6271 address_item **chain = &addr_route;
6272 while (*chain != NULL)
6273 {
6274 address_item *addr2 = *chain;
6275 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6276 {
6277 chain = &(addr2->next);
6278 continue;
6279 }
6280
6281 /* Found a suitable address; take it off the routing list and add it to
6282 the remote delivery list. */
6283
6284 *chain = addr2->next;
6285 addr2->next = addr_remote;
6286 addr_remote = addr2;
6287
6288 /* Copy the routing data */
6289
6290 addr2->domain = addr->domain;
6291 addr2->router = addr->router;
6292 addr2->transport = addr->transport;
6293 addr2->host_list = addr->host_list;
6294 addr2->fallback_hosts = addr->fallback_hosts;
d43cbe25 6295 addr2->prop.errors_address = addr->prop.errors_address;
059ec3d9
PH
6296 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6297
6298 DEBUG(D_deliver|D_route)
6299 {
6300 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6301 "routing %s\n"
6302 "Routing for %s copied from %s\n",
6303 addr2->address, addr2->address, addr->address);
6304 }
6305 }
6306 }
6307 } /* Continue with routing the next address. */
6308 } /* Loop to process any child addresses that the routers created, and
6309 any rerouted addresses that got put back on the new chain. */
6310
6311
6312/* Debugging: show the results of the routing */
6313
6314DEBUG(D_deliver|D_retry|D_route)
6315 {
6316 address_item *p = addr_local;
6317 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6318 debug_printf("After routing:\n Local deliveries:\n");
6319 while (p != NULL)
6320 {
6321 debug_printf(" %s\n", p->address);
6322 p = p->next;
6323 }
6324
6325 p = addr_remote;
6326 debug_printf(" Remote deliveries:\n");
6327 while (p != NULL)
6328 {
6329 debug_printf(" %s\n", p->address);
6330 p = p->next;
6331 }
6332
6333 p = addr_failed;
6334 debug_printf(" Failed addresses:\n");
6335 while (p != NULL)
6336 {
6337 debug_printf(" %s\n", p->address);
6338 p = p->next;
6339 }
6340
6341 p = addr_defer;
6342 debug_printf(" Deferred addresses:\n");
6343 while (p != NULL)
6344 {
6345 debug_printf(" %s\n", p->address);
6346 p = p->next;
6347 }
6348 }
6349
6350/* Free any resources that were cached during routing. */
6351
6352search_tidyup();
6353route_tidyup();
6354
6355/* These two variables are set only during routing, after check_local_user.
6356Ensure they are not set in transports. */
6357
6358local_user_gid = (gid_t)(-1);
6359local_user_uid = (uid_t)(-1);
6360
d7174846
PH
6361/* Check for any duplicate addresses. This check is delayed until after
6362routing, because the flexibility of the routing configuration means that
6363identical addresses with different parentage may end up being redirected to
6364different addresses. Checking for duplicates too early (as we previously used
6365to) makes this kind of thing not work. */
6366
6367do_duplicate_check(&addr_local);
6368do_duplicate_check(&addr_remote);
6369
059ec3d9
PH
6370/* When acting as an MUA wrapper, we proceed only if all addresses route to a
6371remote transport. The check that they all end up in one transaction happens in
6372the do_remote_deliveries() function. */
6373
6374if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
6375 addr_defer != NULL))
6376 {
6377 address_item *addr;
6378 uschar *which, *colon, *msg;
6379
6380 if (addr_local != NULL)
6381 {
6382 addr = addr_local;
6383 which = US"local";
6384 }
6385 else if (addr_defer != NULL)
6386 {
6387 addr = addr_defer;
6388 which = US"deferred";
6389 }
6390 else
6391 {
6392 addr = addr_failed;
6393 which = US"failed";
6394 }
6395
6396 while (addr->parent != NULL) addr = addr->parent;
6397
6398 if (addr->message != NULL)
6399 {
6400 colon = US": ";
6401 msg = addr->message;
6402 }
6403 else colon = msg = US"";
6404
6405 /* We don't need to log here for a forced failure as it will already
6406 have been logged. Defer will also have been logged, but as a defer, so we do
6407 need to do the failure logging. */
6408
6409 if (addr != addr_failed)
6410 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6411 addr->address, which);
6412
6413 /* Always write an error to the caller */
6414
6415 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6416 which, colon, msg);
6417
6418 final_yield = DELIVER_MUA_FAILED;
6419 addr_failed = addr_defer = NULL; /* So that we remove the message */
6420 goto DELIVERY_TIDYUP;
6421 }
6422
6423
6424/* If this is a run to continue deliveries to an external channel that is
6425already set up, defer any local deliveries. */
6426
6427if (continue_transport != NULL)
6428 {
6429 if (addr_defer == NULL) addr_defer = addr_local; else
6430 {
6431 address_item *addr = addr_defer;
6432 while (addr->next != NULL) addr = addr->next;
6433 addr->next = addr_local;
6434 }
6435 addr_local = NULL;
6436 }
6437
6438
6439/* Because address rewriting can happen in the routers, we should not really do
6440ANY deliveries until all addresses have been routed, so that all recipients of
6441the message get the same headers. However, this is in practice not always
6442possible, since sometimes remote addresses give DNS timeouts for days on end.
6443The pragmatic approach is to deliver what we can now, saving any rewritten
6444headers so that at least the next lot of recipients benefit from the rewriting
6445that has already been done.
6446
6447If any headers have been rewritten during routing, update the spool file to
6448remember them for all subsequent deliveries. This can be delayed till later if
6449there is only address to be delivered - if it succeeds the spool write need not
6450happen. */
6451
6452if (header_rewritten &&
6453 ((addr_local != NULL &&
6454 (addr_local->next != NULL || addr_remote != NULL)) ||
6455 (addr_remote != NULL && addr_remote->next != NULL)))
6456 {
6457 /* Panic-dies on error */
6458 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6459 header_rewritten = FALSE;
6460 }
6461
6462
6463/* If there are any deliveries to be done, open the journal file. This is used
6464to record successful deliveries as soon as possible after each delivery is
6465known to be complete. A file opened with O_APPEND is used so that several
6466processes can run simultaneously.
6467
6468The journal is just insurance against crashes. When the spool file is
6469ultimately updated at the end of processing, the journal is deleted. If a
6470journal is found to exist at the start of delivery, the addresses listed
6471therein are added to the non-recipients. */
6472
6473if (addr_local != NULL || addr_remote != NULL)
6474 {
6475 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6476 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6477
6478 if (journal_fd < 0)
6479 {
6480 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6481 spoolname, strerror(errno));
6482 return DELIVER_NOT_ATTEMPTED;
6483 }
6484
6485 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6486 that the mode is correct - the group setting doesn't always seem to get
6487 set automatically. */
6488
1ac6b2e7
JH
6489 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6490 || fchown(journal_fd, exim_uid, exim_gid)
6491 || fchmod(journal_fd, SPOOL_MODE)
6492 )
6493 {
6494 int ret = Uunlink(spoolname);
6495 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6496 spoolname, strerror(errno));
6497 if(ret && errno != ENOENT)
6498 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6499 spoolname, strerror(errno));
6500 return DELIVER_NOT_ATTEMPTED;
6501 }
059ec3d9
PH
6502 }
6503
6504
1ac6b2e7 6505
059ec3d9
PH
6506/* Now we can get down to the business of actually doing deliveries. Local
6507deliveries are done first, then remote ones. If ever the problems of how to
6508handle fallback transports are figured out, this section can be put into a loop
6509for handling fallbacks, though the uid switching will have to be revised. */
6510
f1513293
PH
6511/* Precompile a regex that is used to recognize a parameter in response
6512to an LHLO command, if is isn't already compiled. This may be used on both
6513local and remote LMTP deliveries. */
6514
6515if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6516 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6517
6518/* Handle local deliveries */
6519
059ec3d9
PH
6520if (addr_local != NULL)
6521 {
6522 DEBUG(D_deliver|D_transport)
6523 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6524 do_local_deliveries();
6525 disable_logging = FALSE;
6526 }
6527
6528/* If queue_run_local is set, we do not want to attempt any remote deliveries,
6529so just queue them all. */
6530
6531if (queue_run_local)
6532 {
6533 while (addr_remote != NULL)
6534 {
6535 address_item *addr = addr_remote;
6536 addr_remote = addr->next;
6537 addr->next = NULL;
6538 addr->basic_errno = ERRNO_LOCAL_ONLY;
6539 addr->message = US"remote deliveries suppressed";
6540 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6541 }
6542 }
6543
6544/* Handle remote deliveries */
6545
6546if (addr_remote != NULL)
6547 {
6548 DEBUG(D_deliver|D_transport)
6549 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6550
6551 /* Precompile some regex that are used to recognize parameters in response
6552 to an EHLO command, if they aren't already compiled. */
6553
476be7e2 6554 deliver_init();
6c1c3d1d 6555
059ec3d9
PH
6556 /* Now sort the addresses if required, and do the deliveries. The yield of
6557 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6558 cannot be delivered in one transaction. */
6559
6560 if (remote_sort_domains != NULL) sort_remote_deliveries();
6561 if (!do_remote_deliveries(FALSE))
6562 {
6563 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6564 "be delivered in one transaction");
6565 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6566
6567 final_yield = DELIVER_MUA_FAILED;
6568 addr_failed = addr_defer = NULL; /* So that we remove the message */
6569 goto DELIVERY_TIDYUP;
6570 }
6571
6572 /* See if any of the addresses that failed got put on the queue for delivery
6573 to their fallback hosts. We do it this way because often the same fallback
6574 host is used for many domains, so all can be sent in a single transaction
6575 (if appropriately configured). */
6576
6577 if (addr_fallback != NULL && !mua_wrapper)
6578 {
6579 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6580 addr_remote = addr_fallback;
6581 addr_fallback = NULL;
6582 if (remote_sort_domains != NULL) sort_remote_deliveries();
6583 do_remote_deliveries(TRUE);
6584 }
6585 disable_logging = FALSE;
6586 }
6587
6588
6589/* All deliveries are now complete. Ignore SIGTERM during this tidying up
6590phase, to minimize cases of half-done things. */
6591
6592DEBUG(D_deliver)
6593 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6594
6595/* Root privilege is no longer needed */
6596
6597exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6598
6599set_process_info("tidying up after delivering %s", message_id);
6600signal(SIGTERM, SIG_IGN);
6601
6602/* When we are acting as an MUA wrapper, the smtp transport will either have
47c7a64a
PH
6603succeeded for all addresses, or failed them all in normal cases. However, there
6604are some setup situations (e.g. when a named port does not exist) that cause an
6605immediate exit with deferral of all addresses. Convert those into failures. We
6606do not ever want to retry, nor do we want to send a bounce message. */
059ec3d9
PH
6607
6608if (mua_wrapper)
6609 {
47c7a64a
PH
6610 if (addr_defer != NULL)
6611 {
6612 address_item *addr, *nextaddr;
6613 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6614 {
6615 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6616 "delivery", addr->address);
6617 nextaddr = addr->next;
6618 addr->next = addr_failed;
6619 addr_failed = addr;
6620 }
6621 addr_defer = NULL;
6622 }
6623
6624 /* Now all should either have succeeded or failed. */
6625
059ec3d9
PH
6626 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6627 {
6628 uschar *s = (addr_failed->user_message != NULL)?
6629 addr_failed->user_message : addr_failed->message;
c562fd30 6630 host_item * host;
059ec3d9
PH
6631
6632 fprintf(stderr, "Delivery failed: ");
6633 if (addr_failed->basic_errno > 0)
6634 {
6635 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6636 if (s != NULL) fprintf(stderr, ": ");
6637 }
c562fd30
JH
6638 if ((host = addr_failed->host_used))
6639 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
059ec3d9
PH
6640 if (s == NULL)
6641 {
6642 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6643 }
6644 else fprintf(stderr, "%s", CS s);
6645 fprintf(stderr, "\n");
6646
6647 final_yield = DELIVER_MUA_FAILED;
6648 addr_failed = NULL;
6649 }
6650 }
6651
6652/* In a normal configuration, we now update the retry database. This is done in
6653one fell swoop at the end in order not to keep opening and closing (and
6654locking) the database. The code for handling retries is hived off into a
6655separate module for convenience. We pass it the addresses of the various
6656chains, because deferred addresses can get moved onto the failed chain if the
6657retry cutoff time has expired for all alternative destinations. Bypass the
6658updating of the database if the -N flag is set, which is a debugging thing that
6659prevents actual delivery. */
6660
6661else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6662
6c1c3d1d
WB
6663/* Send DSN for successful messages */
6664addr_dsntmp = addr_succeed;
6665addr_senddsn = NULL;
6666
9671784a 6667while(addr_dsntmp)
6c1c3d1d 6668 {
6c1c3d1d 6669 /* af_ignore_error not honored here. it's not an error */
9671784a
JH
6670 DEBUG(D_deliver)
6671 {
6672 debug_printf("DSN: processing router : %s\n"
6673 "DSN: processing successful delivery address: %s\n"
6674 "DSN: Sender_address: %s\n"
6675 "DSN: orcpt: %s flags: %d\n"
6676 "DSN: envid: %s ret: %d\n"
6677 "DSN: Final recipient: %s\n"
6678 "DSN: Remote SMTP server supports DSN: %d\n",
6679 addr_dsntmp->router->name,
6680 addr_dsntmp->address,
6681 sender_address,
6682 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
6683 dsn_envid, dsn_ret,
6684 addr_dsntmp->address,
6685 addr_dsntmp->dsn_aware
6686 );
6687 }
6c1c3d1d
WB
6688
6689 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6690 and a report was requested */
9671784a
JH
6691 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
6692 || addr_dsntmp->dsn_flags & rf_dsnlasthop
6693 )
6694 && addr_dsntmp->dsn_flags & rf_dsnflags
6695 && addr_dsntmp->dsn_flags & rf_notify_success
6696 )
6c1c3d1d
WB
6697 {
6698 /* copy and relink address_item and send report with all of them at once later */
6699 address_item *addr_next;
6700 addr_next = addr_senddsn;
6701 addr_senddsn = store_get(sizeof(address_item));
6702 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6703 addr_senddsn->next = addr_next;
6704 }
6705 else
9671784a 6706 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6c1c3d1d
WB
6707
6708 addr_dsntmp = addr_dsntmp->next;
6709 }
6710
9671784a 6711if (addr_senddsn)
6c1c3d1d
WB
6712 {
6713 pid_t pid;
6714 int fd;
6715
6716 /* create exim process to send message */
6717 pid = child_open_exim(&fd);
6718
6719 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6720
6721 if (pid < 0) /* Creation of child failed */
6722 {
6723 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6724 "create child process to send failure message: %s", getpid(),
6725 getppid(), strerror(errno));
6726
1c5b1499 6727 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6c1c3d1d
WB
6728 }
6729 else /* Creation of child succeeded */
6730 {
6731 FILE *f = fdopen(fd, "wb");
6732 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6733 int topt = topt_add_return_path | topt_no_body;
45500060 6734 uschar * bound;
6c1c3d1d 6735
1c5b1499
JH
6736 DEBUG(D_deliver)
6737 debug_printf("sending error message to: %s\n", sender_address);
6c1c3d1d
WB
6738
6739 /* build unique id for MIME boundary */
45500060
JH
6740 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6741 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6c1c3d1d 6742
c007c974
JH
6743 if (errors_reply_to)
6744 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6c1c3d1d 6745
c007c974
JH
6746 fprintf(f, "Auto-Submitted: auto-generated\n"
6747 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6748 "To: %s\n"
6749 "Subject: Delivery Status Notification\n"
6750 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6751 "MIME-Version: 1.0\n\n"
6752
6753 "--%s\n"
6754 "Content-type: text/plain; charset=us-ascii\n\n"
6c1c3d1d 6755
c007c974 6756 "This message was created automatically by mail delivery software.\n"
8864c2c4 6757 " ----- The following addresses had successful delivery notifications -----\n",
45500060 6758 qualify_domain_sender, sender_address, bound, bound);
6c1c3d1d 6759
1c5b1499
JH
6760 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
6761 addr_dsntmp = addr_dsntmp->next)
c007c974
JH
6762 fprintf(f, "<%s> (relayed %s)\n\n",
6763 addr_dsntmp->address,
6764 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6765 ? "via non DSN router"
6766 : addr_dsntmp->dsn_aware == dsn_support_no
6767 ? "to non-DSN-aware mailer"
6768 : "via non \"Remote SMTP\" router"
6769 );
1c5b1499 6770
c007c974
JH
6771 fprintf(f, "--%s\n"
6772 "Content-type: message/delivery-status\n\n"
6773 "Reporting-MTA: dns; %s\n",
45500060 6774 bound, smtp_active_hostname);
c007c974 6775
1c5b1499
JH
6776 if (dsn_envid)
6777 { /* must be decoded from xtext: see RFC 3461:6.3a */
6c1c3d1d
WB
6778 uschar *xdec_envid;
6779 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
c007c974 6780 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6c1c3d1d 6781 else
c007c974 6782 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6c1c3d1d 6783 }
c007c974 6784 fputc('\n', f);
6c1c3d1d 6785
c007c974
JH
6786 for (addr_dsntmp = addr_senddsn;
6787 addr_dsntmp;
6788 addr_dsntmp = addr_dsntmp->next)
6c1c3d1d 6789 {
c007c974 6790 if (addr_dsntmp->dsn_orcpt)
6c1c3d1d 6791 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
c007c974
JH
6792
6793 fprintf(f, "Action: delivered\n"
6794 "Final-Recipient: rfc822;%s\n"
6795 "Status: 2.0.0\n",
6796 addr_dsntmp->address);
6797
6798 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
1c5b1499 6799 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
c007c974 6800 addr_dsntmp->host_used->name);
6c1c3d1d 6801 else
1c5b1499 6802 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
c007c974 6803 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6c1c3d1d
WB
6804 }
6805
45500060 6806 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6c1c3d1d
WB
6807
6808 fflush(f);
6809 transport_filter_argv = NULL; /* Just in case */
6810 return_path = sender_address; /* In case not previously set */
6811
6812 /* Write the original email out */
6813 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6814 fflush(f);
6815
21bc4865 6816 fprintf(f,"\n--%s--\n", bound);
6c1c3d1d
WB
6817
6818 fflush(f);
6819 fclose(f);
6820 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6821 }
6822 }
6c1c3d1d 6823
059ec3d9
PH
6824/* If any addresses failed, we must send a message to somebody, unless
6825af_ignore_error is set, in which case no action is taken. It is possible for
6826several messages to get sent if there are addresses with different
6827requirements. */
6828
6829while (addr_failed != NULL)
6830 {
6831 pid_t pid;
6832 int fd;
6833 uschar *logtod = tod_stamp(tod_log);
6834 address_item *addr;
6835 address_item *handled_addr = NULL;
6836 address_item **paddr;
6837 address_item *msgchain = NULL;
6838 address_item **pmsgchain = &msgchain;
6839
6840 /* There are weird cases when logging is disabled in the transport. However,
6841 there may not be a transport (address failed by a router). */
6842
6843 disable_logging = FALSE;
6844 if (addr_failed->transport != NULL)
6845 disable_logging = addr_failed->transport->disable_logging;
6846
6847 DEBUG(D_deliver)
6848 debug_printf("processing failed address %s\n", addr_failed->address);
6849
6850 /* There are only two ways an address in a bounce message can get here:
6851
6852 (1) When delivery was initially deferred, but has now timed out (in the call
6853 to retry_update() above). We can detect this by testing for
6854 af_retry_timedout. If the address does not have its own errors address,
6855 we arrange to ignore the error.
6856
6857 (2) If delivery failures for bounce messages are being ignored. We can detect
6858 this by testing for af_ignore_error. This will also be set if a bounce
6859 message has been autothawed and the ignore_bounce_errors_after time has
6860 passed. It might also be set if a router was explicitly configured to
6861 ignore errors (errors_to = "").
6862
6863 If neither of these cases obtains, something has gone wrong. Log the
6864 incident, but then ignore the error. */
6865
d43cbe25 6866 if (sender_address[0] == 0 && addr_failed->prop.errors_address == NULL)
059ec3d9 6867 {
9671784a
JH
6868 if ( !testflag(addr_failed, af_retry_timedout)
6869 && !testflag(addr_failed, af_ignore_error))
059ec3d9
PH
6870 {
6871 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6872 "failure is neither frozen nor ignored (it's been ignored)");
6873 }
6874 setflag(addr_failed, af_ignore_error);
6875 }
6876
6877 /* If the first address on the list has af_ignore_error set, just remove
6878 it from the list, throw away any saved message file, log it, and
6879 mark the recipient done. */
6880
50dc7409 6881 if ( testflag(addr_failed, af_ignore_error)
9671784a
JH
6882 || ( addr_failed->dsn_flags & rf_dsnflags
6883 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure)
6c1c3d1d 6884 )
1c5b1499 6885 {
059ec3d9
PH
6886 addr = addr_failed;
6887 addr_failed = addr->next;
6888 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6889
6890 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6891 addr->address,
1c5b1499
JH
6892 !addr->parent ? US"" : US" <",
6893 !addr->parent ? US"" : addr->parent->address,
6894 !addr->parent ? US"" : US">");
059ec3d9
PH
6895
6896 address_done(addr, logtod);
6897 child_done(addr, logtod);
6898 /* Panic-dies on error */
6899 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6900 }
6901
6902 /* Otherwise, handle the sending of a message. Find the error address for
6903 the first address, then send a message that includes all failed addresses
6904 that have the same error address. Note the bounce_recipient is a global so
6905 that it can be accesssed by $bounce_recipient while creating a customized
6906 error message. */
6907
6908 else
6909 {
d43cbe25
JH
6910 bounce_recipient = addr_failed->prop.errors_address
6911 ? addr_failed->prop.errors_address : sender_address;
059ec3d9
PH
6912
6913 /* Make a subprocess to send a message */
6914
1c5b1499 6915 if ((pid = child_open_exim(&fd)) < 0)
059ec3d9
PH
6916 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6917 "create child process to send failure message: %s", getpid(),
6918 getppid(), strerror(errno));
6919
6920 /* Creation of child succeeded */
6921
6922 else
6923 {
6924 int ch, rc;
6925 int filecount = 0;
6926 int rcount = 0;
6927 uschar *bcc, *emf_text;
6928 FILE *f = fdopen(fd, "wb");
6929 FILE *emf = NULL;
6930 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6931 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6932 DELIVER_IN_BUFFER_SIZE;
45500060 6933 uschar * bound;
0f9d3aea
JH
6934 uschar *dsnlimitmsg;
6935 uschar *dsnnotifyhdr;
6936 int topt;
059ec3d9
PH
6937
6938 DEBUG(D_deliver)
6939 debug_printf("sending error message to: %s\n", bounce_recipient);
6940
6941 /* Scan the addresses for all that have the same errors address, removing
6942 them from the addr_failed chain, and putting them on msgchain. */
6943
6944 paddr = &addr_failed;
6945 for (addr = addr_failed; addr != NULL; addr = *paddr)
d43cbe25
JH
6946 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
6947 ? addr->prop.errors_address : sender_address) == 0)
1c5b1499 6948 { /* The same - dechain */
059ec3d9
PH
6949 *paddr = addr->next;
6950 *pmsgchain = addr;
6951 addr->next = NULL;
6952 pmsgchain = &(addr->next);
6953 }
1c5b1499
JH
6954 else
6955 paddr = &addr->next; /* Not the same; skip */
059ec3d9
PH
6956
6957 /* Include X-Failed-Recipients: for automatic interpretation, but do
6958 not let any one header line get too long. We do this by starting a
6959 new header every 50 recipients. Omit any addresses for which the
6960 "hide_child" flag is set. */
6961
6962 for (addr = msgchain; addr != NULL; addr = addr->next)
6963 {
6964 if (testflag(addr, af_hide_child)) continue;
6965 if (rcount >= 50)
6966 {
6967 fprintf(f, "\n");
6968 rcount = 0;
6969 }
6970 fprintf(f, "%s%s",
6971 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6972 (testflag(addr, af_pfr) && addr->parent != NULL)?
6973 string_printing(addr->parent->address) :
6974 string_printing(addr->address));
6975 }
6976 if (rcount > 0) fprintf(f, "\n");
6977
6978 /* Output the standard headers */
6979
1c5b1499 6980 if (errors_reply_to)
059ec3d9 6981 fprintf(f, "Reply-To: %s\n", errors_reply_to);
456682f5 6982 fprintf(f, "Auto-Submitted: auto-replied\n");
0e22dfd1 6983 moan_write_from(f);
059ec3d9
PH
6984 fprintf(f, "To: %s\n", bounce_recipient);
6985
6c1c3d1d 6986 /* generate boundary string and output MIME-Headers */
45500060 6987 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
c007c974
JH
6988
6989 fprintf(f, "Content-Type: multipart/report;"
6990 " report-type=delivery-status; boundary=%s\n"
6991 "MIME-Version: 1.0\n",
45500060 6992 bound);
6c1c3d1d 6993
059ec3d9
PH
6994 /* Open a template file if one is provided. Log failure to open, but
6995 carry on - default texts will be used. */
6996
c007c974
JH
6997 if (bounce_message_file)
6998 if (!(emf = Ufopen(bounce_message_file, "rb")))
059ec3d9
PH
6999 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7000 "message texts: %s", bounce_message_file, strerror(errno));
059ec3d9
PH
7001
7002 /* Quietly copy to configured additional addresses if required. */
7003
c007c974
JH
7004 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7005 fprintf(f, "Bcc: %s\n", bcc);
059ec3d9
PH
7006
7007 /* The texts for the message can be read from a template file; if there
7008 isn't one, or if it is too short, built-in texts are used. The first
7009 emf text is a Subject: and any other headers. */
7010
c007c974
JH
7011 if ((emf_text = next_emf(emf, US"header")))
7012 fprintf(f, "%s\n", emf_text);
7013 else
059ec3d9
PH
7014 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7015 to_sender? ": returning message to sender" : "");
059ec3d9 7016
6c1c3d1d 7017 /* output human readable part as text/plain section */
c007c974
JH
7018 fprintf(f, "--%s\n"
7019 "Content-type: text/plain; charset=us-ascii\n\n",
45500060 7020 bound);
6c1c3d1d 7021
c007c974
JH
7022 if ((emf_text = next_emf(emf, US"intro")))
7023 fprintf(f, "%s", CS emf_text);
7024 else
059ec3d9
PH
7025 {
7026 fprintf(f,
7027/* This message has been reworded several times. It seems to be confusing to
7028somebody, however it is worded. I have retreated to the original, simple
7029wording. */
7030"This message was created automatically by mail delivery software.\n");
c007c974
JH
7031
7032 if (bounce_message_text)
7033 fprintf(f, "%s", CS bounce_message_text);
059ec3d9 7034 if (to_sender)
059ec3d9
PH
7035 fprintf(f,
7036"\nA message that you sent could not be delivered to one or more of its\n"
7037"recipients. This is a permanent error. The following address(es) failed:\n");
059ec3d9 7038 else
059ec3d9
PH
7039 fprintf(f,
7040"\nA message sent by\n\n <%s>\n\n"
7041"could not be delivered to one or more of its recipients. The following\n"
7042"address(es) failed:\n", sender_address);
059ec3d9 7043 }
c007c974 7044 fputc('\n', f);
059ec3d9
PH
7045
7046 /* Process the addresses, leaving them on the msgchain if they have a
7047 file name for a return message. (There has already been a check in
447d236c
PH
7048 post_process_one() for the existence of data in the message file.) A TRUE
7049 return from print_address_information() means that the address is not
7050 hidden. */
059ec3d9
PH
7051
7052 paddr = &msgchain;
7053 for (addr = msgchain; addr != NULL; addr = *paddr)
7054 {
7055 if (print_address_information(addr, f, US" ", US"\n ", US""))
447d236c 7056 print_address_error(addr, f, US"");
059ec3d9
PH
7057
7058 /* End the final line for the address */
7059
7060 fputc('\n', f);
7061
7062 /* Leave on msgchain if there's a return file. */
7063
7064 if (addr->return_file >= 0)
7065 {
7066 paddr = &(addr->next);
7067 filecount++;
7068 }
7069
7070 /* Else save so that we can tick off the recipient when the
7071 message is sent. */
7072
7073 else
7074 {
7075 *paddr = addr->next;
7076 addr->next = handled_addr;
7077 handled_addr = addr;
7078 }
7079 }
7080
c007c974 7081 fputc('\n', f);
059ec3d9
PH
7082
7083 /* Get the next text, whether we need it or not, so as to be
7084 positioned for the one after. */
7085
7086 emf_text = next_emf(emf, US"generated text");
7087
7088 /* If there were any file messages passed by the local transports,
7089 include them in the message. Then put the address on the handled chain.
7090 In the case of a batch of addresses that were all sent to the same
7091 transport, the return_file field in all of them will contain the same
7092 fd, and the return_filename field in the *last* one will be set (to the
7093 name of the file). */
7094
c007c974 7095 if (msgchain)
059ec3d9
PH
7096 {
7097 address_item *nextaddr;
7098
c007c974
JH
7099 if (emf_text)
7100 fprintf(f, "%s", CS emf_text);
7101 else
059ec3d9
PH
7102 fprintf(f,
7103 "The following text was generated during the delivery "
7104 "attempt%s:\n", (filecount > 1)? "s" : "");
7105
7106 for (addr = msgchain; addr != NULL; addr = nextaddr)
7107 {
7108 FILE *fm;
7109 address_item *topaddr = addr;
7110
7111 /* List all the addresses that relate to this file */
7112
c007c974
JH
7113 fputc('\n', f);
7114 while(addr) /* Insurance */
059ec3d9
PH
7115 {
7116 print_address_information(addr, f, US"------ ", US"\n ",
7117 US" ------\n");
c007c974 7118 if (addr->return_filename) break;
059ec3d9
PH
7119 addr = addr->next;
7120 }
c007c974 7121 fputc('\n', f);
059ec3d9
PH
7122
7123 /* Now copy the file */
7124
7125 fm = Ufopen(addr->return_filename, "rb");
7126
7127 if (fm == NULL)
7128 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7129 strerror(errno));
7130 else
7131 {
7132 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
f1e894f3 7133 (void)fclose(fm);
059ec3d9
PH
7134 }
7135 Uunlink(addr->return_filename);
7136
7137 /* Can now add to handled chain, first fishing off the next
7138 address on the msgchain. */
7139
7140 nextaddr = addr->next;
7141 addr->next = handled_addr;
7142 handled_addr = topaddr;
7143 }
c007c974 7144 fputc('\n', f);
059ec3d9
PH
7145 }
7146
6c1c3d1d 7147 /* output machine readable part */
9671784a
JH
7148#ifdef EXPERIMENTAL_INTERNATIONAL
7149 if (message_smtputf8)
7150 fprintf(f, "--%s\n"
7151 "Content-type: message/global-delivery-status\n\n"
7152 "Reporting-MTA: dns; %s\n",
7153 bound, smtp_active_hostname);
7154 else
7155#endif
7156 fprintf(f, "--%s\n"
7157 "Content-type: message/delivery-status\n\n"
7158 "Reporting-MTA: dns; %s\n",
7159 bound, smtp_active_hostname);
c007c974
JH
7160
7161 if (dsn_envid)
7162 {
6c1c3d1d
WB
7163 /* must be decoded from xtext: see RFC 3461:6.3a */
7164 uschar *xdec_envid;
7165 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
c007c974 7166 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6c1c3d1d 7167 else
c007c974 7168 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6c1c3d1d 7169 }
c007c974 7170 fputc('\n', f);
6c1c3d1d 7171
c007c974 7172 for (addr = handled_addr; addr; addr = addr->next)
6c1c3d1d 7173 {
c007c974 7174 fprintf(f, "Action: failed\n"
8864c2c4
JH
7175 "Final-Recipient: rfc822;%s\n"
7176 "Status: 5.0.0\n",
7177 addr->address);
c007c974 7178 if (addr->host_used && addr->host_used->name)
21bc4865
WB
7179 {
7180 fprintf(f, "Remote-MTA: dns; %s\n",
7181 addr->host_used->name);
7182 print_dsn_diagnostic_code(addr, f);
7183 }
1c5b1499 7184 fputc('\n', f);
6c1c3d1d 7185 }
6c1c3d1d 7186
059ec3d9
PH
7187 /* Now copy the message, trying to give an intelligible comment if
7188 it is too long for it all to be copied. The limit isn't strictly
7189 applied because of the buffering. There is, however, an option
7190 to suppress copying altogether. */
7191
7192 emf_text = next_emf(emf, US"copy");
7193
6c1c3d1d
WB
7194 /* add message body
7195 we ignore the intro text from template and add
7196 the text for bounce_return_size_limit at the end.
7197
7198 bounce_return_message is ignored
7199 in case RET= is defined we honor these values
7200 otherwise bounce_return_body is honored.
7201
7202 bounce_return_size_limit is always honored.
7203 */
7204
1c5b1499 7205 fprintf(f, "--%s\n", bound);
6c1c3d1d 7206
0f9d3aea
JH
7207 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7208 dsnnotifyhdr = NULL;
7209 topt = topt_add_return_path;
7210
6c1c3d1d
WB
7211 /* RET=HDRS? top priority */
7212 if (dsn_ret == dsn_ret_hdrs)
7213 topt |= topt_no_body;
7214 else
7215 /* no full body return at all? */
7216 if (!bounce_return_body)
7217 {
7218 topt |= topt_no_body;
7219 /* add header if we overrule RET=FULL */
7220 if (dsn_ret == dsn_ret_full)
7221 dsnnotifyhdr = dsnlimitmsg;
7222 }
7223 /* size limited ... return headers only if limit reached */
7224 else if (bounce_return_size_limit > 0)
7225 {
7226 struct stat statbuf;
7227 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7228 {
7229 topt |= topt_no_body;
7230 dsnnotifyhdr = dsnlimitmsg;
7231 }
7232 }
7233
9671784a
JH
7234#ifdef EXPERIMENTAL_INTERNATIONAL
7235 if (message_smtputf8)
7236 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7237 : "Content-type: message/global\n\n",
7238 f);
7239 else
7240#endif
7241 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7242 : "Content-type: message/rfc822\n\n",
7243 f);
6c1c3d1d
WB
7244
7245 fflush(f);
7246 transport_filter_argv = NULL; /* Just in case */
7247 return_path = sender_address; /* In case not previously set */
7248 transport_write_message(NULL, fileno(f), topt,
7249 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7250 fflush(f);
7251
7252 /* we never add the final text. close the file */
c007c974 7253 if (emf)
6c1c3d1d
WB
7254 (void)fclose(emf);
7255
45500060 7256 fprintf(f, "\n--%s--\n", bound);
059ec3d9
PH
7257
7258 /* Close the file, which should send an EOF to the child process
7259 that is receiving the message. Wait for it to finish. */
7260
f1e894f3 7261 (void)fclose(f);
059ec3d9
PH
7262 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7263
7264 /* In the test harness, let the child do it's thing first. */
7265
7266 if (running_in_test_harness) millisleep(500);
7267
7268 /* If the process failed, there was some disaster in setting up the
7269 error message. Unless the message is very old, ensure that addr_defer
7270 is non-null, which will have the effect of leaving the message on the
7271 spool. The failed addresses will get tried again next time. However, we
7272 don't really want this to happen too often, so freeze the message unless
7273 there are some genuine deferred addresses to try. To do this we have
7274 to call spool_write_header() here, because with no genuine deferred
7275 addresses the normal code below doesn't get run. */
7276
7277 if (rc != 0)
7278 {
7279 uschar *s = US"";
7280 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
7281 {
7282 addr_defer = (address_item *)(+1);
7283 deliver_freeze = TRUE;
7284 deliver_frozen_at = time(NULL);
7285 /* Panic-dies on error */
7286 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7287 s = US" (frozen)";
7288 }
7289 deliver_msglog("Process failed (%d) when writing error message "
7290 "to %s%s", rc, bounce_recipient, s);
7291 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7292 "to %s%s", rc, bounce_recipient, s);
7293 }
7294
7295 /* The message succeeded. Ensure that the recipients that failed are
7296 now marked finished with on the spool and their parents updated. */
7297
7298 else
7299 {
7300 for (addr = handled_addr; addr != NULL; addr = addr->next)
7301 {
7302 address_done(addr, logtod);
7303 child_done(addr, logtod);
7304 }
7305 /* Panic-dies on error */
7306 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7307 }
7308 }
7309 }
7310 }
7311
7312disable_logging = FALSE; /* In case left set */
7313
7314/* Come here from the mua_wrapper case if routing goes wrong */
7315
7316DELIVERY_TIDYUP:
7317
7318/* If there are now no deferred addresses, we are done. Preserve the
7319message log if so configured, and we are using them. Otherwise, sling it.
7320Then delete the message itself. */
7321
7322if (addr_defer == NULL)
7323 {
7324 if (message_logs)
7325 {
7326 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7327 id);
7328 if (preserve_message_logs)
7329 {
7330 int rc;
7331 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7332 if ((rc = Urename(spoolname, big_buffer)) < 0)
7333 {
7334 (void)directory_make(spool_directory, US"msglog.OLD",
7335 MSGLOG_DIRECTORY_MODE, TRUE);
7336 rc = Urename(spoolname, big_buffer);
7337 }
7338 if (rc < 0)
7339 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7340 "msglog.OLD directory", spoolname);
7341 }
7342 else
059ec3d9 7343 if (Uunlink(spoolname) < 0)
0761d44e
TF
7344 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7345 spoolname, strerror(errno));
059ec3d9
PH
7346 }
7347
7348 /* Remove the two message files. */
8e669ac1 7349
059ec3d9
PH
7350 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7351 if (Uunlink(spoolname) < 0)
0ca0cf52
TF
7352 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7353 spoolname, strerror(errno));
059ec3d9
PH
7354 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7355 if (Uunlink(spoolname) < 0)
0ca0cf52
TF
7356 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7357 spoolname, strerror(errno));
2ac0e484
PH
7358
7359 /* Log the end of this message, with queue time if requested. */
7360
7361 if ((log_extra_selector & LX_queue_time_overall) != 0)
8e669ac1 7362 log_write(0, LOG_MAIN, "Completed QT=%s",
19050083 7363 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
2ac0e484
PH
7364 else
7365 log_write(0, LOG_MAIN, "Completed");
0e8a9471
MH
7366
7367 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7368 deliver_freeze = FALSE;
14a465c3 7369
774ef2d7
JH
7370#ifdef EXPERIMENTAL_EVENT
7371 (void) event_raise(event_action, US"msg:complete", NULL);
14a465c3
JH
7372#endif
7373}
059ec3d9
PH
7374
7375/* If there are deferred addresses, we are keeping this message because it is
7376not yet completed. Lose any temporary files that were catching output from
7377pipes for any of the deferred addresses, handle one-time aliases, and see if
7378the message has been on the queue for so long that it is time to send a warning
7379message to the sender, unless it is a mailer-daemon. If all deferred addresses
7380have the same domain, we can set deliver_domain for the expansion of
7381delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7382the parent's domain.
7383
7384If all the deferred addresses have an error number that indicates "retry time
7385not reached", skip sending the warning message, because it won't contain the
7386reason for the delay. It will get sent at the next real delivery attempt.
7387However, if at least one address has tried, we'd better include all of them in
7388the message.
7389
7390If we can't make a process to send the message, don't worry.
7391
7392For mailing list expansions we want to send the warning message to the
7393mailing list manager. We can't do a perfect job here, as some addresses may
7394have different errors addresses, but if we take the errors address from
7395each deferred address it will probably be right in most cases.
7396
7397If addr_defer == +1, it means there was a problem sending an error message
7398for failed addresses, and there were no "real" deferred addresses. The value
7399was set just to keep the message on the spool, so there is nothing to do here.
7400*/
7401
7402else if (addr_defer != (address_item *)(+1))
7403 {
7404 address_item *addr;
7405 uschar *recipients = US"";
7406 BOOL delivery_attempted = FALSE;
7407
7408 deliver_domain = testflag(addr_defer, af_pfr)?
7409 addr_defer->parent->domain : addr_defer->domain;
7410
7411 for (addr = addr_defer; addr != NULL; addr = addr->next)
7412 {
7413 address_item *otaddr;
7414
7415 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7416
7417 if (deliver_domain != NULL)
7418 {
55414b25
JH
7419 const uschar *d = testflag(addr, af_pfr)
7420 ? addr->parent->domain : addr->domain;
059ec3d9
PH
7421
7422 /* The domain may be unset for an address that has never been routed
7423 because the system filter froze the message. */
7424
7425 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
7426 }
7427
7428 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
7429
7430 /* Handle the case of one-time aliases. If any address in the ancestry
7431 of this one is flagged, ensure it is in the recipients list, suitably
7432 flagged, and that its parent is marked delivered. */
7433
7434 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
7435 if (otaddr->onetime_parent != NULL) break;
7436
7437 if (otaddr != NULL)
7438 {
7439 int i;
7440 int t = recipients_count;
7441
7442 for (i = 0; i < recipients_count; i++)
7443 {
7444 uschar *r = recipients_list[i].address;
7445 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7446 if (Ustrcmp(otaddr->address, r) == 0) break;
7447 }
7448
7449 /* Didn't find the address already in the list, and did find the
7450 ultimate parent's address in the list. After adding the recipient,
7451 update the errors address in the recipients list. */
7452
7453 if (i >= recipients_count && t < recipients_count)
7454 {
7455 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7456 otaddr->address, otaddr->parent->address);
7457 receive_add_recipient(otaddr->address, t);
d43cbe25 7458 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
059ec3d9
PH
7459 tree_add_nonrecipient(otaddr->parent->address);
7460 update_spool = TRUE;
7461 }
7462 }
7463
7464 /* Except for error messages, ensure that either the errors address for
7465 this deferred address or, if there is none, the sender address, is on the
7466 list of recipients for a warning message. */
7467
7468 if (sender_address[0] != 0)
7469 {
d43cbe25 7470 if (addr->prop.errors_address == NULL)
059ec3d9
PH
7471 {
7472 if (Ustrstr(recipients, sender_address) == NULL)
7473 recipients = string_sprintf("%s%s%s", recipients,
7474 (recipients[0] == 0)? "" : ",", sender_address);
7475 }
7476 else
7477 {
d43cbe25 7478 if (Ustrstr(recipients, addr->prop.errors_address) == NULL)
059ec3d9 7479 recipients = string_sprintf("%s%s%s", recipients,
d43cbe25 7480 (recipients[0] == 0)? "" : ",", addr->prop.errors_address);
059ec3d9
PH
7481 }
7482 }
7483 }
7484
7485 /* Send a warning message if the conditions are right. If the condition check
7486 fails because of a lookup defer, there is nothing we can do. The warning
7487 is not sent. Another attempt will be made at the next delivery attempt (if
7488 it also defers). */
7489
50dc7409
JH
7490 if ( !queue_2stage
7491 && delivery_attempted
7492 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7493 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7494 )
7495 && delay_warning[1] > 0
7496 && sender_address[0] != 0
7497 && ( delay_warning_condition == NULL
7498 || expand_check_condition(delay_warning_condition,
7499 US"delay_warning", US"option")
7500 )
7501 )
059ec3d9
PH
7502 {
7503 int count;
7504 int show_time;
7505 int queue_time = time(NULL) - received_time;
7506
7507 /* When running in the test harness, there's an option that allows us to
7508 fudge this time so as to get repeatability of the tests. Take the first
7509 time off the list. In queue runs, the list pointer gets updated in the
7510 calling process. */
7511
7512 if (running_in_test_harness && fudged_queue_times[0] != 0)
7513 {
7514 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7515 if (qt >= 0)
7516 {
7517 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7518 fudged_queue_times);
7519 queue_time = qt;
7520 }
7521 }
7522
7523 /* See how many warnings we should have sent by now */
7524
7525 for (count = 0; count < delay_warning[1]; count++)
7526 if (queue_time < delay_warning[count+2]) break;
7527
7528 show_time = delay_warning[count+1];
7529
7530 if (count >= delay_warning[1])
7531 {
7532 int extra;
7533 int last_gap = show_time;
7534 if (count > 1) last_gap -= delay_warning[count];
7535 extra = (queue_time - delay_warning[count+1])/last_gap;
7536 show_time += last_gap * extra;
7537 count += extra;
7538 }
7539
7540 DEBUG(D_deliver)
7541 {
7542 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7543 debug_printf("warning counts: required %d done %d\n", count,
7544 warning_count);
7545 }
7546
7547 /* We have computed the number of warnings there should have been by now.
7548 If there haven't been enough, send one, and up the count to what it should
7549 have been. */
7550
7551 if (warning_count < count)
7552 {
7553 header_line *h;
7554 int fd;
7555 pid_t pid = child_open_exim(&fd);
7556
7557 if (pid > 0)
7558 {
7559 uschar *wmf_text;
7560 FILE *wmf = NULL;
7561 FILE *f = fdopen(fd, "wb");
45500060 7562 uschar * bound;
059ec3d9 7563
c007c974 7564 if (warn_message_file)
059ec3d9
PH
7565 {
7566 wmf = Ufopen(warn_message_file, "rb");
7567 if (wmf == NULL)
7568 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7569 "message texts: %s", warn_message_file, strerror(errno));
7570 }
7571
7572 warnmsg_recipients = recipients;
7573 warnmsg_delay = (queue_time < 120*60)?
7574 string_sprintf("%d minutes", show_time/60):
7575 string_sprintf("%d hours", show_time/3600);
7576
c007c974 7577 if (errors_reply_to)
059ec3d9 7578 fprintf(f, "Reply-To: %s\n", errors_reply_to);
456682f5 7579 fprintf(f, "Auto-Submitted: auto-replied\n");
0e22dfd1 7580 moan_write_from(f);
059ec3d9
PH
7581 fprintf(f, "To: %s\n", recipients);
7582
6c1c3d1d 7583 /* generated boundary string and output MIME-Headers */
45500060 7584 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
c007c974
JH
7585
7586 fprintf(f, "Content-Type: multipart/report;"
7587 " report-type=delivery-status; boundary=%s\n"
7588 "MIME-Version: 1.0\n",
45500060 7589 bound);
6c1c3d1d 7590
c007c974 7591 if ((wmf_text = next_emf(wmf, US"header")))
059ec3d9
PH
7592 fprintf(f, "%s\n", wmf_text);
7593 else
7594 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7595 message_id, warnmsg_delay);
7596
6c1c3d1d 7597 /* output human readable part as text/plain section */
c007c974
JH
7598 fprintf(f, "--%s\n"
7599 "Content-type: text/plain; charset=us-ascii\n\n",
45500060 7600 bound);
6c1c3d1d 7601
c007c974
JH
7602 if ((wmf_text = next_emf(wmf, US"intro")))
7603 fprintf(f, "%s", CS wmf_text);
7604 else
059ec3d9
PH
7605 {
7606 fprintf(f,
7607"This message was created automatically by mail delivery software.\n");
7608
7609 if (Ustrcmp(recipients, sender_address) == 0)
7610 fprintf(f,
7611"A message that you sent has not yet been delivered to one or more of its\n"
7612"recipients after more than ");
7613
c007c974
JH
7614 else
7615 fprintf(f,
059ec3d9
PH
7616"A message sent by\n\n <%s>\n\n"
7617"has not yet been delivered to one or more of its recipients after more than \n",
c007c974 7618 sender_address);
059ec3d9 7619
c007c974
JH
7620 fprintf(f, "%s on the queue on %s.\n\n"
7621 "The message identifier is: %s\n",
7622 warnmsg_delay, primary_hostname, message_id);
059ec3d9
PH
7623
7624 for (h = header_list; h != NULL; h = h->next)
059ec3d9
PH
7625 if (strncmpic(h->text, US"Subject:", 8) == 0)
7626 fprintf(f, "The subject of the message is: %s", h->text + 9);
7627 else if (strncmpic(h->text, US"Date:", 5) == 0)
7628 fprintf(f, "The date of the message is: %s", h->text + 6);
c007c974 7629 fputc('\n', f);
059ec3d9
PH
7630
7631 fprintf(f, "The address%s to which the message has not yet been "
7632 "delivered %s:\n",
c007c974
JH
7633 !addr_defer->next ? "" : "es",
7634 !addr_defer->next ? "is": "are");
059ec3d9
PH
7635 }
7636
447d236c 7637 /* List the addresses, with error information if allowed */
059ec3d9 7638
6c1c3d1d
WB
7639 /* store addr_defer for machine readable part */
7640 address_item *addr_dsndefer = addr_defer;
c007c974
JH
7641 fputc('\n', f);
7642 while (addr_defer)
059ec3d9
PH
7643 {
7644 address_item *addr = addr_defer;
7645 addr_defer = addr->next;
447d236c
PH
7646 if (print_address_information(addr, f, US" ", US"\n ", US""))
7647 print_address_error(addr, f, US"Delay reason: ");
c007c974 7648 fputc('\n', f);
059ec3d9 7649 }
c007c974 7650 fputc('\n', f);
059ec3d9
PH
7651
7652 /* Final text */
7653
c007c974 7654 if (wmf)
059ec3d9 7655 {
c007c974
JH
7656 if ((wmf_text = next_emf(wmf, US"final")))
7657 fprintf(f, "%s", CS wmf_text);
f1e894f3 7658 (void)fclose(wmf);
059ec3d9
PH
7659 }
7660 else
7661 {
7662 fprintf(f,
7663"No action is required on your part. Delivery attempts will continue for\n"
7664"some time, and this warning may be repeated at intervals if the message\n"
7665"remains undelivered. Eventually the mail delivery software will give up,\n"
7666"and when that happens, the message will be returned to you.\n");
7667 }
7668
6c1c3d1d 7669 /* output machine readable part */
c007c974
JH
7670 fprintf(f, "\n--%s\n"
7671 "Content-type: message/delivery-status\n\n"
7672 "Reporting-MTA: dns; %s\n",
45500060 7673 bound,
c007c974 7674 smtp_active_hostname);
6c1c3d1d 7675
c007c974
JH
7676
7677 if (dsn_envid)
7678 {
6c1c3d1d
WB
7679 /* must be decoded from xtext: see RFC 3461:6.3a */
7680 uschar *xdec_envid;
7681 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7682 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7683 else
7684 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7685 }
c007c974 7686 fputc('\n', f);
6c1c3d1d 7687
1c5b1499 7688 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
6c1c3d1d 7689 {
c007c974 7690 if (addr_dsndefer->dsn_orcpt)
1c5b1499 7691 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
c007c974 7692
1c5b1499
JH
7693 fprintf(f, "Action: delayed\n"
7694 "Final-Recipient: rfc822;%s\n"
7695 "Status: 4.0.0\n",
7696 addr_dsndefer->address);
c007c974 7697 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
21bc4865 7698 {
1c5b1499 7699 fprintf(f, "Remote-MTA: dns; %s\n",
21bc4865
WB
7700 addr_dsndefer->host_used->name);
7701 print_dsn_diagnostic_code(addr_dsndefer, f);
7702 }
1c5b1499 7703 fputc('\n', f);
6c1c3d1d
WB
7704 }
7705
1c5b1499 7706 fprintf(f, "--%s\n"
c007c974 7707 "Content-type: text/rfc822-headers\n\n",
45500060 7708 bound);
6c1c3d1d
WB
7709
7710 fflush(f);
7711 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7712 int topt = topt_add_return_path | topt_no_body;
7713 transport_filter_argv = NULL; /* Just in case */
7714 return_path = sender_address; /* In case not previously set */
7715 /* Write the original email out */
7716 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7717 fflush(f);
7718
45500060 7719 fprintf(f,"\n--%s--\n", bound);
6c1c3d1d
WB
7720
7721 fflush(f);
6c1c3d1d 7722
059ec3d9
PH
7723 /* Close and wait for child process to complete, without a timeout.
7724 If there's an error, don't update the count. */
7725
f1e894f3 7726 (void)fclose(f);
059ec3d9
PH
7727 if (child_close(pid, 0) == 0)
7728 {
7729 warning_count = count;
7730 update_spool = TRUE; /* Ensure spool rewritten */
7731 }
7732 }
7733 }
7734 }
7735
7736 /* Clear deliver_domain */
7737
7738 deliver_domain = NULL;
7739
7740 /* If this was a first delivery attempt, unset the first time flag, and
7741 ensure that the spool gets updated. */
7742
7743 if (deliver_firsttime)
7744 {
7745 deliver_firsttime = FALSE;
7746 update_spool = TRUE;
7747 }
7748
7749 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7750 message, unless the message is a local error message (to avoid loops). Then
7751 log the freezing. If the text in "frozen_info" came from a system filter,
7752 it has been escaped into printing characters so as not to mess up log lines.
7753 For the "tell" message, we turn \n back into newline. Also, insert a newline
7754 near the start instead of the ": " string. */
7755
7756 if (deliver_freeze)
7757 {
7758 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7759 {
7760 uschar *s = string_copy(frozen_info);
7761 uschar *ss = Ustrstr(s, " by the system filter: ");
7762
7763 if (ss != NULL)
7764 {
7765 ss[21] = '.';
7766 ss[22] = '\n';
7767 }
7768
7769 ss = s;
7770 while (*ss != 0)
7771 {
7772 if (*ss == '\\' && ss[1] == 'n')
7773 {
7774 *ss++ = ' ';
7775 *ss++ = '\n';
7776 }
7777 else ss++;
7778 }
7779 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7780 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7781 s, sender_address);
7782 }
7783
7784 /* Log freezing just before we update the -H file, to minimize the chance
7785 of a race problem. */
7786
7787 deliver_msglog("*** Frozen%s\n", frozen_info);
7788 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7789 }
7790
7791 /* If there have been any updates to the non-recipients list, or other things
7792 that get written to the spool, we must now update the spool header file so
7793 that it has the right information for the next delivery attempt. If there
7794 was more than one address being delivered, the header_change update is done
7795 earlier, in case one succeeds and then something crashes. */
7796
7797 DEBUG(D_deliver)
7798 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7799 update_spool, header_rewritten);
7800
7801 if (update_spool || header_rewritten)
7802 /* Panic-dies on error */
7803 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7804 }
7805
7806/* Finished with the message log. If the message is complete, it will have
7807been unlinked or renamed above. */
7808
f1e894f3 7809if (message_logs) (void)fclose(message_log);
059ec3d9
PH
7810
7811/* Now we can close and remove the journal file. Its only purpose is to record
7812successfully completed deliveries asap so that this information doesn't get
7813lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7814not serious, as trying it again is not harmful. The journal might not be open
7815if all addresses were deferred at routing or directing. Nevertheless, we must
7816remove it if it exists (may have been lying around from a crash during the
7817previous delivery attempt). We don't remove the journal if a delivery
7818subprocess failed to pass back delivery information; this is controlled by
7819the remove_journal flag. When the journal is left, we also don't move the
7820message off the main spool if frozen and the option is set. It should get moved
7821at the next attempt, after the journal has been inspected. */
7822
f1e894f3 7823if (journal_fd >= 0) (void)close(journal_fd);
059ec3d9
PH
7824
7825if (remove_journal)
7826 {
7827 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7828 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7829 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7830 strerror(errno));
7831
7832 /* Move the message off the spool if reqested */
7833
a7538db1 7834#ifdef SUPPORT_MOVE_FROZEN_MESSAGES
059ec3d9
PH
7835 if (deliver_freeze && move_frozen_messages)
7836 (void)spool_move_message(id, message_subdir, US"", US"F");
a7538db1 7837#endif
059ec3d9
PH
7838 }
7839
7840/* Closing the data file frees the lock; if the file has been unlinked it
7841will go away. Otherwise the message becomes available for another process
7842to try delivery. */
7843
f1e894f3 7844(void)close(deliver_datafile);
059ec3d9
PH
7845deliver_datafile = -1;
7846DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7847
7848/* It is unlikely that there will be any cached resources, since they are
7849released after routing, and in the delivery subprocesses. However, it's
7850possible for an expansion for something afterwards (for example,
7851expand_check_condition) to do a lookup. We must therefore be sure everything is
7852released. */
7853
7854search_tidyup();
faa05a93 7855acl_where = ACL_WHERE_UNKNOWN;
059ec3d9
PH
7856return final_yield;
7857}
7858
476be7e2
JH
7859
7860
7861void
7862deliver_init(void)
7863{
7864if (!regex_PIPELINING) regex_PIPELINING =
7865 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
7866
7867if (!regex_SIZE) regex_SIZE =
7868 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
7869
7870if (!regex_AUTH) regex_AUTH =
7871 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
7872 FALSE, TRUE);
7873
7874#ifdef SUPPORT_TLS
7875if (!regex_STARTTLS) regex_STARTTLS =
7876 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
7877#endif
7878
7879#ifndef DISABLE_PRDR
7880if (!regex_PRDR) regex_PRDR =
7881 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
7882#endif
7883
7ade712c
JH
7884#ifdef SUPPORT_TLS
7885if (!regex_UTF8) regex_UTF8 =
7886 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
7887#endif
7888
476be7e2
JH
7889if (!regex_DSN) regex_DSN =
7890 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
7891
7892if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
7893 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7894}
7895
7896
a39bd74d
JB
7897uschar *
7898deliver_get_sender_address (uschar * id)
7899{
7900if (!spool_open_datafile(id))
7901 return NULL;
7902
7903sprintf(CS spoolname, "%s-H", id);
7904if (spool_read_header(spoolname, TRUE, TRUE) != spool_read_OK)
7905 return NULL;
7906
7907(void)close(deliver_datafile);
7908deliver_datafile = -1;
7909
7910return sender_address;
7911}
7912
67d81c10
JH
7913/* vi: aw ai sw=2
7914*/
059ec3d9 7915/* End of deliver.c */