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