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