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