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