Fix ultimate retry timeouts for intermittently deliverable recipients.
[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
ba9af0af
TF
2386 to do, which is for the ultimate address timeout. We also do this
2387 check during routing so this one might be redundant... */
059ec3d9
PH
2388
2389 if (!ok)
ba9af0af
TF
2390 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2391 retry_record, now);
059ec3d9
PH
2392 }
2393 }
2394 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2395 }
2396
2397 /* This address is to be delivered. Leave it on the chain. */
2398
2399 if (ok)
2400 {
2401 addr3 = addr2;
2402 addr2 = addr2->next;
2403 }
2404
2405 /* This address is to be deferred. Take it out of the chain, and
2406 post-process it as complete. Must take it out of the chain first,
2407 because post processing puts it on another chain. */
2408
2409 else
2410 {
2411 address_item *this = addr2;
2412 this->message = US"Retry time not yet reached";
2413 this->basic_errno = ERRNO_LRETRY;
2414 if (addr3 == NULL) addr2 = addr = addr2->next;
2415 else addr2 = addr3->next = addr2->next;
2416 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2417 }
2418 }
2419
2420 if (dbm_file != NULL) dbfn_close(dbm_file);
2421
2422 /* If there are no addresses left on the chain, they all deferred. Loop
2423 for the next set of addresses. */
2424
2425 if (addr == NULL) continue;
2426
2427 /* So, finally, we do have some addresses that can be passed to the
2428 transport. Before doing so, set up variables that are relevant to a
2429 single delivery. */
2430
2431 deliver_set_expansions(addr);
2432 delivery_start = time(NULL);
2433 deliver_local(addr, FALSE);
2434 deliver_time = (int)(time(NULL) - delivery_start);
2435
2436 /* If a shadow transport (which must perforce be another local transport), is
2437 defined, and its condition is met, we must pass the message to the shadow
2438 too, but only those addresses that succeeded. We do this by making a new
2439 chain of addresses - also to keep the original chain uncontaminated. We must
2440 use a chain rather than doing it one by one, because the shadow transport may
2441 batch.
2442
2443 NOTE: if the condition fails because of a lookup defer, there is nothing we
2444 can do! */
2445
2446 if (tp->shadow != NULL &&
2447 (tp->shadow_condition == NULL ||
2448 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2449 {
2450 transport_instance *stp;
2451 address_item *shadow_addr = NULL;
2452 address_item **last = &shadow_addr;
2453
2454 for (stp = transports; stp != NULL; stp = stp->next)
2455 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2456
2457 if (stp == NULL)
2458 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2459 tp->shadow);
2460
2461 /* Pick off the addresses that have succeeded, and make clones. Put into
2462 the shadow_message field a pointer to the shadow_message field of the real
2463 address. */
2464
2465 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2466 {
2467 if (addr2->transport_return != OK) continue;
2468 addr3 = store_get(sizeof(address_item));
2469 *addr3 = *addr2;
2470 addr3->next = NULL;
2471 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2472 addr3->transport = stp;
2473 addr3->transport_return = DEFER;
2474 addr3->return_filename = NULL;
2475 addr3->return_file = -1;
2476 *last = addr3;
2477 last = &(addr3->next);
2478 }
2479
2480 /* If we found any addresses to shadow, run the delivery, and stick any
2481 message back into the shadow_message field in the original. */
2482
2483 if (shadow_addr != NULL)
2484 {
2485 int save_count = transport_count;
2486
2487 DEBUG(D_deliver|D_transport)
2488 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2489 deliver_local(shadow_addr, TRUE);
2490
2491 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2492 {
2493 int sresult = shadow_addr->transport_return;
2494 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2495 string_sprintf(" ST=%s", stp->name) :
2496 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2497 (shadow_addr->basic_errno <= 0)?
2498 US"" : US strerror(shadow_addr->basic_errno),
2499 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2500 US"" : US": ",
2501 (shadow_addr->message != NULL)? shadow_addr->message :
2502 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2503
2504 DEBUG(D_deliver|D_transport)
2505 debug_printf("%s shadow transport returned %s for %s\n",
2506 stp->name,
2507 (sresult == OK)? "OK" :
2508 (sresult == DEFER)? "DEFER" :
2509 (sresult == FAIL)? "FAIL" :
2510 (sresult == PANIC)? "PANIC" : "?",
2511 shadow_addr->address);
2512 }
2513
2514 DEBUG(D_deliver|D_transport)
2515 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2516
2517 transport_count = save_count; /* Restore original transport count */
2518 }
2519 }
2520
2521 /* Cancel the expansions that were set up for the delivery. */
2522
2523 deliver_set_expansions(NULL);
2524
2525 /* Now we can process the results of the real transport. We must take each
2526 address off the chain first, because post_process_one() puts it on another
2527 chain. */
2528
2529 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2530 {
2531 int result = addr2->transport_return;
2532 nextaddr = addr2->next;
2533
2534 DEBUG(D_deliver|D_transport)
2535 debug_printf("%s transport returned %s for %s\n",
2536 tp->name,
2537 (result == OK)? "OK" :
2538 (result == DEFER)? "DEFER" :
2539 (result == FAIL)? "FAIL" :
2540 (result == PANIC)? "PANIC" : "?",
2541 addr2->address);
2542
2543 /* If there is a retry_record, or if delivery is deferred, build a retry
2544 item for setting a new retry time or deleting the old retry record from
2545 the database. These items are handled all together after all addresses
2546 have been handled (so the database is open just for a short time for
2547 updating). */
2548
2549 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2550 {
2551 int flags = (result == DEFER)? 0 : rf_delete;
2552 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2553 addr2->address_retry_key : addr2->domain_retry_key);
2554 *retry_key = 'T';
2555 retry_add_item(addr2, retry_key, flags);
2556 }
2557
2558 /* Done with this address */
2559
2560 if (result == OK) addr2->more_errno = deliver_time;
2561 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2562
2563 /* If a pipe delivery generated text to be sent back, the result may be
2564 changed to FAIL, and we must copy this for subsequent addresses in the
2565 batch. */
2566
2567 if (addr2->transport_return != result)
2568 {
2569 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2570 {
2571 addr3->transport_return = addr2->transport_return;
2572 addr3->basic_errno = addr2->basic_errno;
2573 addr3->message = addr2->message;
2574 }
2575 result = addr2->transport_return;
2576 }
2577
2578 /* Whether or not the result was changed to FAIL, we need to copy the
2579 return_file value from the first address into all the addresses of the
2580 batch, so they are all listed in the error message. */
2581
2582 addr2->return_file = addr->return_file;
2583
2584 /* Change log character for recording successful deliveries. */
2585
2586 if (result == OK) logchar = '-';
2587 }
2588 } /* Loop back for next batch of addresses */
2589}
2590
2591
2592
2593
2594/*************************************************
2595* Sort remote deliveries *
2596*************************************************/
2597
2598/* This function is called if remote_sort_domains is set. It arranges that the
2599chain of addresses for remote deliveries is ordered according to the strings
2600specified. Try to make this shuffling reasonably efficient by handling
2601sequences of addresses rather than just single ones.
2602
2603Arguments: None
2604Returns: Nothing
2605*/
2606
2607static void
2608sort_remote_deliveries(void)
2609{
2610int sep = 0;
2611address_item **aptr = &addr_remote;
2612uschar *listptr = remote_sort_domains;
2613uschar *pattern;
2614uschar patbuf[256];
2615
2616while (*aptr != NULL &&
2617 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2618 != NULL)
2619 {
2620 address_item *moved = NULL;
2621 address_item **bptr = &moved;
2622
2623 while (*aptr != NULL)
2624 {
2625 address_item **next;
2626 deliver_domain = (*aptr)->domain; /* set $domain */
2627 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2628 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2629 {
2630 aptr = &((*aptr)->next);
2631 continue;
2632 }
2633
2634 next = &((*aptr)->next);
2635 while (*next != NULL &&
2636 (deliver_domain = (*next)->domain, /* Set $domain */
2637 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2638 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2639 next = &((*next)->next);
2640
2641 /* If the batch of non-matchers is at the end, add on any that were
2642 extracted further up the chain, and end this iteration. Otherwise,
2643 extract them from the chain and hang on the moved chain. */
2644
2645 if (*next == NULL)
2646 {
2647 *next = moved;
2648 break;
2649 }
2650
2651 *bptr = *aptr;
2652 *aptr = *next;
2653 *next = NULL;
2654 bptr = next;
2655 aptr = &((*aptr)->next);
2656 }
2657
2658 /* If the loop ended because the final address matched, *aptr will
2659 be NULL. Add on to the end any extracted non-matching addresses. If
2660 *aptr is not NULL, the loop ended via "break" when *next is null, that
2661 is, there was a string of non-matching addresses at the end. In this
2662 case the extracted addresses have already been added on the end. */
2663
2664 if (*aptr == NULL) *aptr = moved;
2665 }
2666
2667DEBUG(D_deliver)
2668 {
2669 address_item *addr;
2670 debug_printf("remote addresses after sorting:\n");
2671 for (addr = addr_remote; addr != NULL; addr = addr->next)
2672 debug_printf(" %s\n", addr->address);
2673 }
2674}
2675
2676
2677
2678/*************************************************
2679* Read from pipe for remote delivery subprocess *
2680*************************************************/
2681
2682/* This function is called when the subprocess is complete, but can also be
2683called before it is complete, in order to empty a pipe that is full (to prevent
2684deadlock). It must therefore keep track of its progress in the parlist data
2685block.
2686
2687We read the pipe to get the delivery status codes and a possible error message
2688for each address, optionally preceded by unusability data for the hosts and
2689also by optional retry data.
2690
2691Read in large chunks into the big buffer and then scan through, interpreting
2692the data therein. In most cases, only a single read will be necessary. No
1c5466b9
PH
2693individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2694that we read the next chunk when there is less than 2500 bytes left in the
2695non-final chunk, we can assume each item is complete in the buffer before
2696handling it. Each item is written using a single write(), which is atomic for
2697small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2698often bigger) so even if we are reading while the subprocess is still going, we
2699should never have only a partial item in the buffer.
059ec3d9
PH
2700
2701Argument:
2702 poffset the offset of the parlist item
2703 eop TRUE if the process has completed
2704
2705Returns: TRUE if the terminating 'Z' item has been read,
2706 or there has been a disaster (i.e. no more data needed);
2707 FALSE otherwise
2708*/
2709
2710static BOOL
2711par_read_pipe(int poffset, BOOL eop)
2712{
2713host_item *h;
2714pardata *p = parlist + poffset;
2715address_item *addrlist = p->addrlist;
2716address_item *addr = p->addr;
2717pid_t pid = p->pid;
2718int fd = p->fd;
2719uschar *endptr = big_buffer;
2720uschar *ptr = endptr;
2721uschar *msg = p->msg;
2722BOOL done = p->done;
2723BOOL unfinished = TRUE;
2724
2725/* Loop through all items, reading from the pipe when necessary. The pipe
2726is set up to be non-blocking, but there are two different Unix mechanisms in
2727use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2728and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2729which returns 0 for both end of file and no more data. We distinguish the
2730two cases by taking 0 as end of file only when we know the process has
2731completed.
2732
2733Each separate item is written to the pipe in a single write(), and as they are
2734all short items, the writes will all be atomic and we should never find
8e669ac1
PH
2735ourselves in the position of having read an incomplete item. "Short" in this
2736case can mean up to about 1K in the case when there is a long error message
1c5466b9 2737associated with an address. */
059ec3d9
PH
2738
2739DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2740 (int)p->pid, eop? "ended" : "not ended");
2741
2742while (!done)
2743 {
2744 retry_item *r, **rp;
2745 int remaining = endptr - ptr;
2746
2747 /* Read (first time) or top up the chars in the buffer if necessary.
2748 There will be only one read if we get all the available data (i.e. don't
2749 fill the buffer completely). */
2750
1c5466b9 2751 if (remaining < 2500 && unfinished)
059ec3d9
PH
2752 {
2753 int len;
2754 int available = big_buffer_size - remaining;
2755
2756 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2757
2758 ptr = big_buffer;
2759 endptr = big_buffer + remaining;
2760 len = read(fd, endptr, available);
2761
2762 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2763
2764 /* If the result is EAGAIN and the process is not complete, just
2765 stop reading any more and process what we have already. */
2766
2767 if (len < 0)
2768 {
2769 if (!eop && errno == EAGAIN) len = 0; else
2770 {
2771 msg = string_sprintf("failed to read pipe from transport process "
2772 "%d for transport %s: %s", pid, addr->transport->driver_name,
2773 strerror(errno));
2774 break;
2775 }
2776 }
2777
2778 /* If the length is zero (eof or no-more-data), just process what we
2779 already have. Note that if the process is still running and we have
2780 read all the data in the pipe (but less that "available") then we
2781 won't read any more, as "unfinished" will get set FALSE. */
2782
2783 endptr += len;
2784 unfinished = len == available;
2785 }
2786
2787 /* If we are at the end of the available data, exit the loop. */
2788
2789 if (ptr >= endptr) break;
2790
2791 /* Handle each possible type of item, assuming the complete item is
2792 available in store. */
2793
2794 switch (*ptr++)
2795 {
2796 /* Host items exist only if any hosts were marked unusable. Match
2797 up by checking the IP address. */
2798
2799 case 'H':
2800 for (h = addrlist->host_list; h != NULL; h = h->next)
2801 {
2802 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2803 h->status = ptr[0];
2804 h->why = ptr[1];
2805 }
2806 ptr += 2;
2807 while (*ptr++);
2808 break;
2809
2810 /* Retry items are sent in a preceding R item for each address. This is
2811 kept separate to keep each message short enough to guarantee it won't
2812 be split in the pipe. Hopefully, in the majority of cases, there won't in
2813 fact be any retry items at all.
2814
2815 The complete set of retry items might include an item to delete a
2816 routing retry if there was a previous routing delay. However, routing
2817 retries are also used when a remote transport identifies an address error.
2818 In that case, there may also be an "add" item for the same key. Arrange
2819 that a "delete" item is dropped in favour of an "add" item. */
2820
2821 case 'R':
2822 if (addr == NULL) goto ADDR_MISMATCH;
2823
2824 DEBUG(D_deliver|D_retry)
2825 debug_printf("reading retry information for %s from subprocess\n",
2826 ptr+1);
2827
2828 /* Cut out any "delete" items on the list. */
2829
2830 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2831 {
2832 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2833 {
2834 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2835 *rp = r->next; /* Excise a delete item */
2836 DEBUG(D_deliver|D_retry)
2837 debug_printf(" existing delete item dropped\n");
2838 }
2839 }
2840
2841 /* We want to add a delete item only if there is no non-delete item;
2842 however we still have to step ptr through the data. */
2843
2844 if (r == NULL || (*ptr & rf_delete) == 0)
2845 {
2846 r = store_get(sizeof(retry_item));
2847 r->next = addr->retries;
2848 addr->retries = r;
2849 r->flags = *ptr++;
2850 r->key = string_copy(ptr);
2851 while (*ptr++);
2852 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2853 ptr += sizeof(r->basic_errno);
2854 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2855 ptr += sizeof(r->more_errno);
2856 r->message = (*ptr)? string_copy(ptr) : NULL;
2857 DEBUG(D_deliver|D_retry)
2858 debug_printf(" added %s item\n",
2859 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2860 }
2861
2862 else
2863 {
2864 DEBUG(D_deliver|D_retry)
2865 debug_printf(" delete item not added: non-delete item exists\n");
2866 ptr++;
2867 while(*ptr++);
2868 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2869 }
2870
2871 while(*ptr++);
2872 break;
2873
2874 /* Put the amount of data written into the parlist block */
2875
2876 case 'S':
2877 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2878 ptr += sizeof(transport_count);
2879 break;
2880
2881 /* Address items are in the order of items on the address chain. We
2882 remember the current address value in case this function is called
2883 several times to empty the pipe in stages. Information about delivery
2884 over TLS is sent in a preceding X item for each address. We don't put
2885 it in with the other info, in order to keep each message short enough to
2886 guarantee it won't be split in the pipe. */
2887
2888 #ifdef SUPPORT_TLS
2889 case 'X':
2890 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2891 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2892 while (*ptr++);
2893 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2894 while (*ptr++);
2895 break;
2896 #endif
2897
6f123593
JH
2898 case 'C': /* client authenticator information */
2899 switch (*ptr++)
2900 {
2901 case '1':
018c60d7 2902 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
6f123593
JH
2903 break;
2904 case '2':
018c60d7 2905 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
6f123593 2906 break;
c8e2fc1e 2907 case '3':
018c60d7 2908 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
c8e2fc1e 2909 break;
6f123593
JH
2910 }
2911 while (*ptr++);
2912 break;
2913
059ec3d9
PH
2914 case 'A':
2915 if (addr == NULL)
2916 {
2917 ADDR_MISMATCH:
2918 msg = string_sprintf("address count mismatch for data read from pipe "
2919 "for transport process %d for transport %s", pid,
2920 addrlist->transport->driver_name);
2921 done = TRUE;
2922 break;
2923 }
2924
2925 addr->transport_return = *ptr++;
2926 addr->special_action = *ptr++;
2927 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2928 ptr += sizeof(addr->basic_errno);
2929 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2930 ptr += sizeof(addr->more_errno);
2931 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2932 ptr += sizeof(addr->flags);
2933 addr->message = (*ptr)? string_copy(ptr) : NULL;
2934 while(*ptr++);
2935 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2936 while(*ptr++);
2937
2938 /* Always two strings for host information, followed by the port number */
2939
2940 if (*ptr != 0)
2941 {
2942 h = store_get(sizeof(host_item));
2943 h->name = string_copy(ptr);
2944 while (*ptr++);
2945 h->address = string_copy(ptr);
2946 while(*ptr++);
2947 memcpy(&(h->port), ptr, sizeof(h->port));
2948 ptr += sizeof(h->port);
2949 addr->host_used = h;
2950 }
2951 else ptr++;
2952
2953 /* Finished with this address */
2954
2955 addr = addr->next;
2956 break;
2957
2958 /* Z marks the logical end of the data. It is followed by '0' if
2959 continue_transport was NULL at the end of transporting, otherwise '1'.
2960 We need to know when it becomes NULL during a delivery down a passed SMTP
2961 channel so that we don't try to pass anything more down it. Of course, for
2962 most normal messages it will remain NULL all the time. */
2963
2964 case 'Z':
2965 if (*ptr == '0')
2966 {
2967 continue_transport = NULL;
2968 continue_hostname = NULL;
2969 }
2970 done = TRUE;
2971 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
2972 break;
2973
2974 /* Anything else is a disaster. */
2975
2976 default:
2977 msg = string_sprintf("malformed data (%d) read from pipe for transport "
2978 "process %d for transport %s", ptr[-1], pid,
2979 addr->transport->driver_name);
2980 done = TRUE;
2981 break;
2982 }
2983 }
2984
2985/* The done flag is inspected externally, to determine whether or not to
2986call the function again when the process finishes. */
2987
2988p->done = done;
2989
2990/* If the process hadn't finished, and we haven't seen the end of the data
2991or suffered a disaster, update the rest of the state, and return FALSE to
2992indicate "not finished". */
2993
2994if (!eop && !done)
2995 {
2996 p->addr = addr;
2997 p->msg = msg;
2998 return FALSE;
2999 }
3000
3001/* Close our end of the pipe, to prevent deadlock if the far end is still
3002pushing stuff into it. */
3003
f1e894f3 3004(void)close(fd);
059ec3d9
PH
3005p->fd = -1;
3006
3007/* If we have finished without error, but haven't had data for every address,
3008something is wrong. */
3009
3010if (msg == NULL && addr != NULL)
3011 msg = string_sprintf("insufficient address data read from pipe "
3012 "for transport process %d for transport %s", pid,
3013 addr->transport->driver_name);
3014
3015/* If an error message is set, something has gone wrong in getting back
3016the delivery data. Put the message into each address and freeze it. */
3017
3018if (msg != NULL)
3019 {
3020 for (addr = addrlist; addr != NULL; addr = addr->next)
3021 {
3022 addr->transport_return = DEFER;
3023 addr->special_action = SPECIAL_FREEZE;
3024 addr->message = msg;
3025 }
3026 }
3027
3028/* Return TRUE to indicate we have got all we need from this process, even
3029if it hasn't actually finished yet. */
3030
3031return TRUE;
3032}
3033
3034
3035
3036/*************************************************
3037* Post-process a set of remote addresses *
3038*************************************************/
3039
3040/* Do what has to be done immediately after a remote delivery for each set of
3041addresses, then re-write the spool if necessary. Note that post_process_one
3042puts the address on an appropriate queue; hence we must fish off the next
3043one first. This function is also called if there is a problem with setting
3044up a subprocess to do a remote delivery in parallel. In this case, the final
3045argument contains a message, and the action must be forced to DEFER.
3046
3047Argument:
3048 addr pointer to chain of address items
3049 logflags flags for logging
3050 msg NULL for normal cases; -> error message for unexpected problems
3051 fallback TRUE if processing fallback hosts
3052
3053Returns: nothing
3054*/
3055
3056static void
3057remote_post_process(address_item *addr, int logflags, uschar *msg,
3058 BOOL fallback)
3059{
3060host_item *h;
3061
3062/* If any host addresses were found to be unusable, add them to the unusable
3063tree so that subsequent deliveries don't try them. */
3064
3065for (h = addr->host_list; h != NULL; h = h->next)
3066 {
3067 if (h->address == NULL) continue;
3068 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3069 }
3070
3071/* Now handle each address on the chain. The transport has placed '=' or '-'
3072into the special_action field for each successful delivery. */
3073
3074while (addr != NULL)
3075 {
3076 address_item *next = addr->next;
3077
3078 /* If msg == NULL (normal processing) and the result is DEFER and we are
3079 processing the main hosts and there are fallback hosts available, put the
3080 address on the list for fallback delivery. */
3081
3082 if (addr->transport_return == DEFER &&
3083 addr->fallback_hosts != NULL &&
3084 !fallback &&
3085 msg == NULL)
3086 {
3087 addr->host_list = addr->fallback_hosts;
3088 addr->next = addr_fallback;
3089 addr_fallback = addr;
3090 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3091 }
3092
3093 /* If msg is set (=> unexpected problem), set it in the address before
3094 doing the ordinary post processing. */
3095
3096 else
3097 {
3098 if (msg != NULL)
3099 {
3100 addr->message = msg;
3101 addr->transport_return = DEFER;
3102 }
3103 (void)post_process_one(addr, addr->transport_return, logflags,
3104 DTYPE_TRANSPORT, addr->special_action);
3105 }
3106
3107 /* Next address */
3108
3109 addr = next;
3110 }
3111
3112/* If we have just delivered down a passed SMTP channel, and that was
3113the last address, the channel will have been closed down. Now that
3114we have logged that delivery, set continue_sequence to 1 so that
3115any subsequent deliveries don't get "*" incorrectly logged. */
3116
3117if (continue_transport == NULL) continue_sequence = 1;
3118}
3119
3120
3121
3122/*************************************************
3123* Wait for one remote delivery subprocess *
3124*************************************************/
3125
3126/* This function is called while doing remote deliveries when either the
3127maximum number of processes exist and we need one to complete so that another
3128can be created, or when waiting for the last ones to complete. It must wait for
3129the completion of one subprocess, empty the control block slot, and return a
3130pointer to the address chain.
3131
3132Arguments: none
3133Returns: pointer to the chain of addresses handled by the process;
3134 NULL if no subprocess found - this is an unexpected error
3135*/
3136
3137static address_item *
3138par_wait(void)
3139{
3140int poffset, status;
3141address_item *addr, *addrlist;
3142pid_t pid;
3143
3144set_process_info("delivering %s: waiting for a remote delivery subprocess "
3145 "to finish", message_id);
3146
3147/* Loop until either a subprocess completes, or there are no subprocesses in
3148existence - in which case give an error return. We cannot proceed just by
3149waiting for a completion, because a subprocess may have filled up its pipe, and
3150be waiting for it to be emptied. Therefore, if no processes have finished, we
3151wait for one of the pipes to acquire some data by calling select(), with a
3152timeout just in case.
3153
3154The simple approach is just to iterate after reading data from a ready pipe.
3155This leads to non-ideal behaviour when the subprocess has written its final Z
3156item, closed the pipe, and is in the process of exiting (the common case). A
3157call to waitpid() yields nothing completed, but select() shows the pipe ready -
3158reading it yields EOF, so you end up with busy-waiting until the subprocess has
3159actually finished.
3160
3161To avoid this, if all the data that is needed has been read from a subprocess
3162after select(), an explicit wait() for it is done. We know that all it is doing
3163is writing to the pipe and then exiting, so the wait should not be long.
3164
3165The non-blocking waitpid() is to some extent just insurance; if we could
3166reliably detect end-of-file on the pipe, we could always know when to do a
3167blocking wait() for a completed process. However, because some systems use
3168NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3169use code that functions without the need to recognize EOF.
3170
3171There's a double loop here just in case we end up with a process that is not in
3172the list of remote delivery processes. Something has obviously gone wrong if
3173this is the case. (For example, a process that is incorrectly left over from
3174routing or local deliveries might be found.) The damage can be minimized by
3175looping back and looking for another process. If there aren't any, the error
3176return will happen. */
3177
3178for (;;) /* Normally we do not repeat this loop */
3179 {
3180 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3181 {
3182 struct timeval tv;
3183 fd_set select_pipes;
3184 int maxpipe, readycount;
3185
3186 /* A return value of -1 can mean several things. If errno != ECHILD, it
3187 either means invalid options (which we discount), or that this process was
3188 interrupted by a signal. Just loop to try the waitpid() again.
3189
3190 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3191 in existence. This should never happen, and is an unexpected error.
3192 However, there is a nasty complication when running under Linux. If "strace
3193 -f" is being used under Linux to trace this process and its children,
3194 subprocesses are "stolen" from their parents and become the children of the
3195 tracing process. A general wait such as the one we've just obeyed returns
3196 as if there are no children while subprocesses are running. Once a
3197 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3198 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3199 palliative.
3200
3201 This does not happen using "truss" on Solaris, nor (I think) with other
3202 tracing facilities on other OS. It seems to be specific to Linux.
3203
3204 What we do to get round this is to use kill() to see if any of our
3205 subprocesses are still in existence. If kill() gives an OK return, we know
3206 it must be for one of our processes - it can't be for a re-use of the pid,
3207 because if our process had finished, waitpid() would have found it. If any
3208 of our subprocesses are in existence, we proceed to use select() as if
3209 waitpid() had returned zero. I think this is safe. */
3210
3211 if (pid < 0)
3212 {
3213 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3214
3215 DEBUG(D_deliver)
3216 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3217 "for process existence\n");
3218
3219 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3220 {
3221 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3222 {
3223 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3224 "stolen by strace\n", (int)pid);
3225 break; /* With poffset set */
3226 }
3227 }
3228
3229 if (poffset >= remote_max_parallel)
3230 {
3231 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3232 return NULL; /* This is the error return */
3233 }
3234 }
3235
3236 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3237 been handled above. A return value of zero means that there is at least one
3238 subprocess, but there are no completed subprocesses. See if any pipes are
3239 ready with any data for reading. */
3240
3241 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3242
3243 maxpipe = 0;
3244 FD_ZERO(&select_pipes);
3245 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3246 {
3247 if (parlist[poffset].pid != 0)
3248 {
3249 int fd = parlist[poffset].fd;
3250 FD_SET(fd, &select_pipes);
3251 if (fd > maxpipe) maxpipe = fd;
3252 }
3253 }
3254
3255 /* Stick in a 60-second timeout, just in case. */
3256
3257 tv.tv_sec = 60;
3258 tv.tv_usec = 0;
3259
3260 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3261 NULL, NULL, &tv);
3262
3263 /* Scan through the pipes and read any that are ready; use the count
3264 returned by select() to stop when there are no more. Select() can return
3265 with no processes (e.g. if interrupted). This shouldn't matter.
3266
3267 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3268 read, or there was a disaster. In either case, we are finished with this
3269 process. Do an explicit wait() for the process and break the main loop if
3270 it succeeds.
3271
3272 It turns out that we have to deal with the case of an interrupted system
3273 call, which can happen on some operating systems if the signal handling is
3274 set up to do that by default. */
3275
3276 for (poffset = 0;
3277 readycount > 0 && poffset < remote_max_parallel;
3278 poffset++)
3279 {
3280 if ((pid = parlist[poffset].pid) != 0 &&
3281 FD_ISSET(parlist[poffset].fd, &select_pipes))
3282 {
3283 readycount--;
3284 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3285 {
3286 for (;;) /* Loop for signals */
3287 {
3288 pid_t endedpid = waitpid(pid, &status, 0);
3289 if (endedpid == pid) goto PROCESS_DONE;
3290 if (endedpid != (pid_t)(-1) || errno != EINTR)
3291 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3292 "%d (errno = %d) from waitpid() for process %d",
3293 (int)endedpid, errno, (int)pid);
3294 }
3295 }
3296 }
3297 }
3298
3299 /* Now go back and look for a completed subprocess again. */
3300 }
3301
3302 /* A completed process was detected by the non-blocking waitpid(). Find the
3303 data block that corresponds to this subprocess. */
3304
3305 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3306 if (pid == parlist[poffset].pid) break;
3307
3308 /* Found the data block; this is a known remote delivery process. We don't
3309 need to repeat the outer loop. This should be what normally happens. */
3310
3311 if (poffset < remote_max_parallel) break;
3312
3313 /* This situation is an error, but it's probably better to carry on looking
3314 for another process than to give up (as we used to do). */
3315
3316 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3317 "transport process list", pid);
3318 } /* End of the "for" loop */
3319
3320/* Come here when all the data was completely read after a select(), and
3321the process in pid has been wait()ed for. */
3322
3323PROCESS_DONE:
3324
3325DEBUG(D_deliver)
3326 {
3327 if (status == 0)
3328 debug_printf("remote delivery process %d ended\n", (int)pid);
3329 else
3330 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3331 status);
3332 }
3333
3334set_process_info("delivering %s", message_id);
3335
3336/* Get the chain of processed addresses */
3337
3338addrlist = parlist[poffset].addrlist;
3339
3340/* If the process did not finish cleanly, record an error and freeze (except
3341for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3342in case the delivery did actually happen. */
3343
3344if ((status & 0xffff) != 0)
3345 {
3346 uschar *msg;
3347 int msb = (status >> 8) & 255;
3348 int lsb = status & 255;
3349 int code = (msb == 0)? (lsb & 0x7f) : msb;
3350
3351 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3352 "%s %d",
3353 addrlist->transport->driver_name,
3354 status,
3355 (msb == 0)? "terminated by signal" : "exit code",
3356 code);
3357
3358 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3359 addrlist->special_action = SPECIAL_FREEZE;
3360
3361 for (addr = addrlist; addr != NULL; addr = addr->next)
3362 {
3363 addr->transport_return = DEFER;
3364 addr->message = msg;
3365 }
3366
3367 remove_journal = FALSE;
3368 }
3369
3370/* Else complete reading the pipe to get the result of the delivery, if all
3371the data has not yet been obtained. */
3372
3373else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3374
3375/* Put the data count and return path into globals, mark the data slot unused,
3376decrement the count of subprocesses, and return the address chain. */
3377
3378transport_count = parlist[poffset].transport_count;
3379used_return_path = parlist[poffset].return_path;
3380parlist[poffset].pid = 0;
3381parcount--;
3382return addrlist;
3383}
3384
3385
3386
3387/*************************************************
3388* Wait for subprocesses and post-process *
3389*************************************************/
3390
3391/* This function waits for subprocesses until the number that are still running
3392is below a given threshold. For each complete subprocess, the addresses are
3393post-processed. If we can't find a running process, there is some shambles.
3394Better not bomb out, as that might lead to multiple copies of the message. Just
3395log and proceed as if all done.
3396
3397Arguments:
3398 max maximum number of subprocesses to leave running
3399 fallback TRUE if processing fallback hosts
3400
3401Returns: nothing
3402*/
3403
3404static void
3405par_reduce(int max, BOOL fallback)
3406{
3407while (parcount > max)
3408 {
3409 address_item *doneaddr = par_wait();
3410 if (doneaddr == NULL)
3411 {
3412 log_write(0, LOG_MAIN|LOG_PANIC,
3413 "remote delivery process count got out of step");
3414 parcount = 0;
3415 }
3416 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3417 }
3418}
3419
3420
3421
3422
1ac6b2e7
JH
3423static void
3424rmt_dlv_checked_write(int fd, void * buf, int size)
3425{
3426int ret = write(fd, buf, size);
3427if(ret != size)
3428 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3429 ret == -1 ? strerror(errno) : "short write");
3430}
3431
059ec3d9
PH
3432/*************************************************
3433* Do remote deliveries *
3434*************************************************/
3435
3436/* This function is called to process the addresses in addr_remote. We must
3437pick off the queue all addresses that have the same transport, remote
3438destination, and errors address, and hand them to the transport in one go,
3439subject to some configured limitations. If this is a run to continue delivering
3440to an existing delivery channel, skip all but those addresses that can go to
3441that channel. The skipped addresses just get deferred.
3442
3443If mua_wrapper is set, all addresses must be able to be sent in a single
3444transaction. If not, this function yields FALSE.
3445
3446In Exim 4, remote deliveries are always done in separate processes, even
3447if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3448is so that the base process can retain privilege. This makes the
3449implementation of fallback transports feasible (though not initially done.)
3450
3451We create up to the configured number of subprocesses, each of which passes
3452back the delivery state via a pipe. (However, when sending down an existing
3453connection, remote_max_parallel is forced to 1.)
3454
3455Arguments:
3456 fallback TRUE if processing fallback hosts
3457
3458Returns: TRUE normally
3459 FALSE if mua_wrapper is set and the addresses cannot all be sent
3460 in one transaction
3461*/
3462
3463static BOOL
3464do_remote_deliveries(BOOL fallback)
3465{
3466int parmax;
3467int delivery_count;
3468int poffset;
3469
3470parcount = 0; /* Number of executing subprocesses */
3471
3472/* When sending down an existing channel, only do one delivery at a time.
3473We use a local variable (parmax) to hold the maximum number of processes;
3474this gets reduced from remote_max_parallel if we can't create enough pipes. */
3475
3476if (continue_transport != NULL) remote_max_parallel = 1;
3477parmax = remote_max_parallel;
3478
3479/* If the data for keeping a list of processes hasn't yet been
3480set up, do so. */
3481
3482if (parlist == NULL)
3483 {
3484 parlist = store_get(remote_max_parallel * sizeof(pardata));
3485 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3486 parlist[poffset].pid = 0;
3487 }
3488
3489/* Now loop for each remote delivery */
3490
3491for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3492 {
3493 pid_t pid;
3494 uid_t uid;
3495 gid_t gid;
3496 int pfd[2];
3497 int address_count = 1;
3498 int address_count_max;
3499 BOOL multi_domain;
3500 BOOL use_initgroups;
3501 BOOL pipe_done = FALSE;
3502 transport_instance *tp;
3503 address_item **anchor = &addr_remote;
3504 address_item *addr = addr_remote;
3505 address_item *last = addr;
3506 address_item *next;
3507
3508 /* Pull the first address right off the list. */
3509
3510 addr_remote = addr->next;
3511 addr->next = NULL;
3512
3513 DEBUG(D_deliver|D_transport)
3514 debug_printf("--------> %s <--------\n", addr->address);
3515
3516 /* If no transport has been set, there has been a big screw-up somewhere. */
3517
3518 if ((tp = addr->transport) == NULL)
3519 {
3520 disable_logging = FALSE; /* Jic */
3521 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3522 US"No transport set by router", fallback);
3523 continue;
3524 }
3525
3526 /* Check that this base address hasn't previously been delivered to this
3527 transport. The check is necessary at this point to handle homonymic addresses
3528 correctly in cases where the pattern of redirection changes between delivery
3529 attempts. Non-homonymic previous delivery is detected earlier, at routing
3530 time. */
3531
c2c19e9d 3532 if (previously_transported(addr, FALSE)) continue;
059ec3d9
PH
3533
3534 /* Force failure if the message is too big. */
3535
3536 if (tp->message_size_limit != NULL)
3537 {
3538 int rc = check_message_size(tp, addr);
3539 if (rc != OK)
3540 {
3541 addr->transport_return = rc;
3542 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3543 continue;
3544 }
3545 }
3546
3547 /* Get the flag which specifies whether the transport can handle different
3548 domains that nevertheless resolve to the same set of hosts. */
3549
3550 multi_domain = tp->multi_domain;
3551
3552 /* Get the maximum it can handle in one envelope, with zero meaning
3553 unlimited, which is forced for the MUA wrapper case. */
3554
3555 address_count_max = tp->max_addresses;
3556 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3557
3558
3559 /************************************************************************/
3560 /***** This is slightly experimental code, but should be safe. *****/
3561
3562 /* The address_count_max value is the maximum number of addresses that the
3563 transport can send in one envelope. However, the transport must be capable of
3564 dealing with any number of addresses. If the number it gets exceeds its
3565 envelope limitation, it must send multiple copies of the message. This can be
3566 done over a single connection for SMTP, so uses less resources than making
3567 multiple connections. On the other hand, if remote_max_parallel is greater
3568 than one, it is perhaps a good idea to use parallel processing to move the
3569 message faster, even if that results in multiple simultaneous connections to
3570 the same host.
3571
3572 How can we come to some compromise between these two ideals? What we do is to
3573 limit the number of addresses passed to a single instance of a transport to
3574 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3575 number of addresses routed to remote transports divided by
3576 remote_max_parallel. For example, if the message has 100 remote recipients,
3577 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3578 once. But if rcpt_max is 100, we could send up to 100.
3579
3580 Of course, not all the remotely addresses in a message are going to go to the
3581 same set of hosts (except in smarthost configurations), so this is just a
3582 heuristic way of dividing up the work.
3583
3584 Furthermore (1), because this may not be wanted in some cases, and also to
3585 cope with really pathological cases, there is also a limit to the number of
3586 messages that are sent over one connection. This is the same limit that is
3587 used when sending several different messages over the same connection.
3588 Continue_sequence is set when in this situation, to the number sent so
3589 far, including this message.
3590
3591 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3592 is probably because they are using VERP, in which case they want to pass only
3593 one address at a time to the transport, in order to be able to use
3594 $local_part and $domain in constructing a new return path. We could test for
3595 the use of these variables, but as it is so likely they will be used when the
3596 maximum is 1, we don't bother. Just leave the value alone. */
3597
3598 if (address_count_max != 1 &&
3599 address_count_max < remote_delivery_count/remote_max_parallel)
3600 {
3601 int new_max = remote_delivery_count/remote_max_parallel;
3602 int message_max = tp->connection_max_messages;
3603 if (connection_max_messages >= 0) message_max = connection_max_messages;
3604 message_max -= continue_sequence - 1;
3605 if (message_max > 0 && new_max > address_count_max * message_max)
3606 new_max = address_count_max * message_max;
3607 address_count_max = new_max;
3608 }
3609
3610 /************************************************************************/
3611
3612
3613 /* Pick off all addresses which have the same transport, errors address,
3614 destination, and extra headers. In some cases they point to the same host
3615 list, but we also need to check for identical host lists generated from
3616 entirely different domains. The host list pointers can be NULL in the case
3617 where the hosts are defined in the transport. There is also a configured
3618 maximum limit of addresses that can be handled at once (see comments above
3619 for how it is computed). */
3620
3621 while ((next = *anchor) != NULL && address_count < address_count_max)
3622 {
3623 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3624 &&
3625 tp == next->transport
3626 &&
3627 same_hosts(next->host_list, addr->host_list)
3628 &&
3629 same_strings(next->p.errors_address, addr->p.errors_address)
3630 &&
3631 same_headers(next->p.extra_headers, addr->p.extra_headers)
3632 &&
3633 same_ugid(tp, next, addr)
3634 &&
3635 (next->p.remove_headers == addr->p.remove_headers ||
3636 (next->p.remove_headers != NULL &&
3637 addr->p.remove_headers != NULL &&
3638 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3639 {
3640 *anchor = next->next;
3641 next->next = NULL;
3642 next->first = addr; /* remember top one (for retry processing) */
3643 last->next = next;
3644 last = next;
3645 address_count++;
3646 }
3647 else anchor = &(next->next);
3648 }
3649
3650 /* If we are acting as an MUA wrapper, all addresses must go in a single
3651 transaction. If not, put them back on the chain and yield FALSE. */
3652
3653 if (mua_wrapper && addr_remote != NULL)
3654 {
3655 last->next = addr_remote;
3656 addr_remote = addr;
3657 return FALSE;
3658 }
3659
3660 /* Set up the expansion variables for this set of addresses */
3661
3662 deliver_set_expansions(addr);
3663
018c60d7
JH
3664 /* Ensure any transport-set auth info is fresh */
3665 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3666
059ec3d9
PH
3667 /* Compute the return path, expanding a new one if required. The old one
3668 must be set first, as it might be referred to in the expansion. */
3669
384152a6
TK
3670 if(addr->p.errors_address != NULL)
3671 return_path = addr->p.errors_address;
3672#ifdef EXPERIMENTAL_SRS
3673 else if(addr->p.srs_sender != NULL)
3674 return_path = addr->p.srs_sender;
3675#endif
3676 else
3677 return_path = sender_address;
059ec3d9
PH
3678
3679 if (tp->return_path != NULL)
3680 {
3681 uschar *new_return_path = expand_string(tp->return_path);
3682 if (new_return_path == NULL)
3683 {
3684 if (!expand_string_forcedfail)
3685 {
3686 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3687 string_sprintf("Failed to expand return path \"%s\": %s",
3688 tp->return_path, expand_string_message), fallback);
3689 continue;
3690 }
3691 }
3692 else return_path = new_return_path;
3693 }
3694
929ba01c
PH
3695 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3696 logs and sets up error messages, so we just post-process and continue with
3697 the next address. */
3698
3699 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3700 {
3701 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3702 continue;
3703 }
3704
059ec3d9
PH
3705 /* If this transport has a setup function, call it now so that it gets
3706 run in this process and not in any subprocess. That way, the results of
929ba01c
PH
3707 any setup that are retained by the transport can be reusable. One of the
3708 things the setup does is to set the fallback host lists in the addresses.
3709 That is why it is called at this point, before the continue delivery
3710 processing, because that might use the fallback hosts. */
059ec3d9
PH
3711
3712 if (tp->setup != NULL)
929ba01c 3713 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
059ec3d9
PH
3714
3715 /* If this is a run to continue delivery down an already-established
3716 channel, check that this set of addresses matches the transport and
3717 the channel. If it does not, defer the addresses. If a host list exists,
3718 we must check that the continue host is on the list. Otherwise, the
3719 host is set in the transport. */
3720
3721 continue_more = FALSE; /* In case got set for the last lot */
3722 if (continue_transport != NULL)
3723 {
3724 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3725 if (ok && addr->host_list != NULL)
3726 {
3727 host_item *h;
3728 ok = FALSE;
3729 for (h = addr->host_list; h != NULL; h = h->next)
3730 {
3731 if (Ustrcmp(h->name, continue_hostname) == 0)
3732 { ok = TRUE; break; }
3733 }
3734 }
3735
3736 /* Addresses not suitable; defer or queue for fallback hosts (which
3737 might be the continue host) and skip to next address. */
3738
3739 if (!ok)
3740 {
3741 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3742 next = addr;
3743
3744 if (addr->fallback_hosts != NULL && !fallback)
3745 {
3746 for (;;)
3747 {
3748 next->host_list = next->fallback_hosts;
3749 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3750 if (next->next == NULL) break;
3751 next = next->next;
3752 }
3753 next->next = addr_fallback;
3754 addr_fallback = addr;
3755 }
3756
3757 else
3758 {
3759 while (next->next != NULL) next = next->next;
3760 next->next = addr_defer;
3761 addr_defer = addr;
3762 }
3763
3764 continue;
3765 }
3766
3767 /* Set a flag indicating whether there are further addresses that list
3768 the continued host. This tells the transport to leave the channel open,
3769 but not to pass it to another delivery process. */
3770
3771 for (next = addr_remote; next != NULL; next = next->next)
3772 {
3773 host_item *h;
3774 for (h = next->host_list; h != NULL; h = h->next)
3775 {
3776 if (Ustrcmp(h->name, continue_hostname) == 0)
3777 { continue_more = TRUE; break; }
3778 }
3779 }
3780 }
3781
3782 /* The transports set up the process info themselves as they may connect
3783 to more than one remote machine. They also have to set up the filter
3784 arguments, if required, so that the host name and address are available
3785 for expansion. */
3786
3787 transport_filter_argv = NULL;
3788
059ec3d9
PH
3789 /* Create the pipe for inter-process communication. If pipe creation
3790 fails, it is probably because the value of remote_max_parallel is so
3791 large that too many file descriptors for pipes have been created. Arrange
3792 to wait for a process to finish, and then try again. If we still can't
3793 create a pipe when all processes have finished, break the retry loop. */
3794
3795 while (!pipe_done)
3796 {
3797 if (pipe(pfd) == 0) pipe_done = TRUE;
3798 else if (parcount > 0) parmax = parcount;
3799 else break;
3800
3801 /* We need to make the reading end of the pipe non-blocking. There are
3802 two different options for this. Exim is cunningly (I hope!) coded so
3803 that it can use either of them, though it prefers O_NONBLOCK, which
3804 distinguishes between EOF and no-more-data. */
3805
3806 #ifdef O_NONBLOCK
ff790e47 3807 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
059ec3d9 3808 #else
ff790e47 3809 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
059ec3d9
PH
3810 #endif
3811
3812 /* If the maximum number of subprocesses already exist, wait for a process
3813 to finish. If we ran out of file descriptors, parmax will have been reduced
3814 from its initial value of remote_max_parallel. */
3815
3816 par_reduce(parmax - 1, fallback);
3817 }
3818
3819 /* If we failed to create a pipe and there were no processes to wait
3820 for, we have to give up on this one. Do this outside the above loop
3821 so that we can continue the main loop. */
3822
3823 if (!pipe_done)
3824 {
3825 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3826 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3827 continue;
3828 }
3829
3830 /* Find a free slot in the pardata list. Must do this after the possible
3831 waiting for processes to finish, because a terminating process will free
3832 up a slot. */
3833
3834 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3835 if (parlist[poffset].pid == 0) break;
3836
3837 /* If there isn't one, there has been a horrible disaster. */
3838
3839 if (poffset >= remote_max_parallel)
3840 {
f1e894f3
PH
3841 (void)close(pfd[pipe_write]);
3842 (void)close(pfd[pipe_read]);
059ec3d9
PH
3843 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3844 US"Unexpectedly no free subprocess slot", fallback);
3845 continue;
3846 }
3847
3848 /* Now fork a subprocess to do the remote delivery, but before doing so,
3849 ensure that any cached resourses are released so as not to interfere with
3850 what happens in the subprocess. */
3851
3852 search_tidyup();
3853
3854 if ((pid = fork()) == 0)
3855 {
3856 int fd = pfd[pipe_write];
3857 host_item *h;
3858
3859 /* There are weird circumstances in which logging is disabled */
3860
3861 disable_logging = tp->disable_logging;
3862
3863 /* Show pids on debug output if parallelism possible */
3864
3865 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3866 {
3867 DEBUG(D_any|D_v) debug_selector |= D_pid;
3868 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3869 }
3870
3871 /* Reset the random number generator, so different processes don't all
3872 have the same sequence. In the test harness we want different, but
3873 predictable settings for each delivery process, so do something explicit
3874 here rather they rely on the fixed reset in the random number function. */
3875
3876 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3877
3878 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3879 a new process that may be forked to do another delivery down the same
3880 SMTP connection. */
3881
ff790e47 3882 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
059ec3d9
PH
3883
3884 /* Close open file descriptors for the pipes of other processes
3885 that are running in parallel. */
3886
3887 for (poffset = 0; poffset < remote_max_parallel; poffset++)
f1e894f3 3888 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
059ec3d9
PH
3889
3890 /* This process has inherited a copy of the file descriptor
3891 for the data file, but its file pointer is shared with all the
3892 other processes running in parallel. Therefore, we have to re-open
3893 the file in order to get a new file descriptor with its own
3894 file pointer. We don't need to lock it, as the lock is held by
3895 the parent process. There doesn't seem to be any way of doing
3896 a dup-with-new-file-pointer. */
3897
f1e894f3 3898 (void)close(deliver_datafile);
059ec3d9
PH
3899 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3900 message_id);
3901 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3902
3903 if (deliver_datafile < 0)
3904 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3905 "parallel delivery: %s", spoolname, strerror(errno));
3906
3907 /* Set the close-on-exec flag */
3908
ff790e47 3909 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
059ec3d9
PH
3910 FD_CLOEXEC);
3911
3912 /* Set the uid/gid of this process; bombs out on failure. */
3913
3914 exim_setugid(uid, gid, use_initgroups,
3915 string_sprintf("remote delivery to %s with transport=%s",
3916 addr->address, tp->name));
3917
3918 /* Close the unwanted half of this process' pipe, set the process state,
3919 and run the transport. Afterwards, transport_count will contain the number
3920 of bytes written. */
3921
f1e894f3 3922 (void)close(pfd[pipe_read]);
059ec3d9
PH
3923 set_process_info("delivering %s using %s", message_id, tp->name);
3924 debug_print_string(tp->debug_string);
3925 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3926
3927 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3928 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3929
3930 /* Ensure any cached resources that we used are now released */
3931
3932 search_tidyup();
3933
3934 /* Pass the result back down the pipe. This is a lot more information
3935 than is needed for a local delivery. We have to send back the error
3936 status for each address, the usability status for each host that is
3937 flagged as unusable, and all the retry items. When TLS is in use, we
3938 send also the cipher and peerdn information. Each type of information
3939 is flagged by an identifying byte, and is then in a fixed format (with
3940 strings terminated by zeros), and there is a final terminator at the
3941 end. The host information and retry information is all attached to
3942 the first address, so that gets sent at the start. */
3943
3944 /* Host unusability information: for most success cases this will
3945 be null. */
3946
3947 for (h = addr->host_list; h != NULL; h = h->next)
3948 {
3949 if (h->address == NULL || h->status < hstatus_unusable) continue;
3950 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
1ac6b2e7 3951 rmt_dlv_checked_write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
059ec3d9
PH
3952 }
3953
3954 /* The number of bytes written. This is the same for each address. Even
3955 if we sent several copies of the message down the same connection, the
3956 size of each one is the same, and it's that value we have got because
3957 transport_count gets reset before calling transport_write_message(). */
3958
3959 big_buffer[0] = 'S';
3960 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
1ac6b2e7 3961 rmt_dlv_checked_write(fd, big_buffer, sizeof(transport_count) + 1);
059ec3d9 3962
6f123593
JH
3963 /* Information about what happened to each address. Four item types are
3964 used: an optional 'X' item first, for TLS information, then an optional "C"
3965 item for any client-auth info followed by 'R' items for any retry settings,
3966 and finally an 'A' item for the remaining data. */
059ec3d9
PH
3967
3968 for(; addr != NULL; addr = addr->next)
3969 {
3970 uschar *ptr;
3971 retry_item *r;
3972
3973 /* The certificate verification status goes into the flags */
3974
817d9f57 3975 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
059ec3d9
PH
3976
3977 /* Use an X item only if there's something to send */
3978
3979 #ifdef SUPPORT_TLS
3980 if (addr->cipher != NULL)
3981 {
3982 ptr = big_buffer;
6f123593 3983 sprintf(CS ptr, "X%.128s", addr->cipher);
059ec3d9
PH
3984 while(*ptr++);
3985 if (addr->peerdn == NULL) *ptr++ = 0; else
3986 {
3987 sprintf(CS ptr, "%.512s", addr->peerdn);
3988 while(*ptr++);
3989 }
1ac6b2e7 3990 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
059ec3d9
PH
3991 }
3992 #endif
3993
6f123593
JH
3994 if (client_authenticator)
3995 {
3996 ptr = big_buffer;
3997 sprintf(CS big_buffer, "C1%.64s", client_authenticator);
3998 while(*ptr++);
1ac6b2e7 3999 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
6f123593
JH
4000 }
4001 if (client_authenticated_id)
4002 {
4003 ptr = big_buffer;
4004 sprintf(CS big_buffer, "C2%.64s", client_authenticated_id);
4005 while(*ptr++);
1ac6b2e7 4006 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
6f123593 4007 }
c8e2fc1e
JH
4008 if (client_authenticated_sender)
4009 {
4010 ptr = big_buffer;
4011 sprintf(CS big_buffer, "C3%.64s", client_authenticated_sender);
4012 while(*ptr++);
1ac6b2e7 4013 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
c8e2fc1e 4014 }
6f123593 4015
059ec3d9
PH
4016 /* Retry information: for most success cases this will be null. */
4017
4018 for (r = addr->retries; r != NULL; r = r->next)
4019 {
4020 uschar *ptr;
4021 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
4022 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4023 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4024 ptr += sizeof(r->basic_errno);
4025 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4026 ptr += sizeof(r->more_errno);
4027 if (r->message == NULL) *ptr++ = 0; else
4028 {
4029 sprintf(CS ptr, "%.512s", r->message);
4030 while(*ptr++);
4031 }
1ac6b2e7 4032 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
059ec3d9
PH
4033 }
4034
4035 /* The rest of the information goes in an 'A' item. */
4036
4037 ptr = big_buffer + 3;
4038 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
4039 addr->special_action);
4040 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4041 ptr += sizeof(addr->basic_errno);
4042 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4043 ptr += sizeof(addr->more_errno);
4044 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4045 ptr += sizeof(addr->flags);
4046
4047 if (addr->message == NULL) *ptr++ = 0; else
4048 {
4049 sprintf(CS ptr, "%.1024s", addr->message);
4050 while(*ptr++);
4051 }
4052
4053 if (addr->user_message == NULL) *ptr++ = 0; else
4054 {
4055 sprintf(CS ptr, "%.1024s", addr->user_message);
4056 while(*ptr++);
4057 }
4058
4059 if (addr->host_used == NULL) *ptr++ = 0; else
4060 {
4061 sprintf(CS ptr, "%.256s", addr->host_used->name);
4062 while(*ptr++);
4063 sprintf(CS ptr, "%.64s", addr->host_used->address);
4064 while(*ptr++);
4065 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4066 ptr += sizeof(addr->host_used->port);
4067 }
1ac6b2e7 4068 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
059ec3d9
PH
4069 }
4070
4071 /* Add termination flag, close the pipe, and that's it. The character
4072 after 'Z' indicates whether continue_transport is now NULL or not.
4073 A change from non-NULL to NULL indicates a problem with a continuing
4074 connection. */
4075
4076 big_buffer[0] = 'Z';
4077 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
1ac6b2e7 4078 rmt_dlv_checked_write(fd, big_buffer, 2);
f1e894f3 4079 (void)close(fd);
059ec3d9
PH
4080 exit(EXIT_SUCCESS);
4081 }
4082
4083 /* Back in the mainline: close the unwanted half of the pipe. */
4084
f1e894f3 4085 (void)close(pfd[pipe_write]);
059ec3d9
PH
4086
4087 /* Fork failed; defer with error message */
4088
4089 if (pid < 0)
4090 {
f1e894f3 4091 (void)close(pfd[pipe_read]);
059ec3d9
PH
4092 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4093 string_sprintf("fork failed for remote delivery to %s: %s",
4094 addr->domain, strerror(errno)), fallback);
4095 continue;
4096 }
4097
4098 /* Fork succeeded; increment the count, and remember relevant data for
4099 when the process finishes. */
4100
4101 parcount++;
4102 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4103 parlist[poffset].pid = pid;
4104 parlist[poffset].fd = pfd[pipe_read];
4105 parlist[poffset].done = FALSE;
4106 parlist[poffset].msg = NULL;
4107 parlist[poffset].return_path = return_path;
4108
4109 /* If the process we've just started is sending a message down an existing
4110 channel, wait for it now. This ensures that only one such process runs at
4111 once, whatever the value of remote_max parallel. Otherwise, we might try to
4112 send two or more messages simultaneously down the same channel. This could
4113 happen if there are different domains that include the same host in otherwise
4114 different host lists.
4115
4116 Also, if the transport closes down the channel, this information gets back
4117 (continue_transport gets set to NULL) before we consider any other addresses
4118 in this message. */
4119
4120 if (continue_transport != NULL) par_reduce(0, fallback);
4121
4122 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4123 newly created process get going before we create another process. This should
4124 ensure repeatability in the tests. We only need to wait a tad. */
4125
4126 else if (running_in_test_harness) millisleep(500);
4127 }
4128
4129/* Reached the end of the list of addresses. Wait for all the subprocesses that
4130are still running and post-process their addresses. */
4131
4132par_reduce(0, fallback);
4133return TRUE;
4134}
4135
4136
4137
4138
4139/*************************************************
4140* Split an address into local part and domain *
4141*************************************************/
4142
4143/* This function initializes an address for routing by splitting it up into a
4144local part and a domain. The local part is set up twice - once in its original
4145casing, and once in lower case, and it is dequoted. We also do the "percent
4146hack" for configured domains. This may lead to a DEFER result if a lookup
4147defers. When a percent-hacking takes place, we insert a copy of the original
4148address as a new parent of this address, as if we have had a redirection.
4149
4150Argument:
4151 addr points to an addr_item block containing the address
4152
4153Returns: OK
4154 DEFER - could not determine if domain is %-hackable
4155*/
4156
4157int
4158deliver_split_address(address_item *addr)
4159{
4160uschar *address = addr->address;
4161uschar *domain = Ustrrchr(address, '@');
4162uschar *t;
4163int len = domain - address;
4164
4165addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4166
4167/* The implication in the RFCs (though I can't say I've seen it spelled out
4168explicitly) is that quoting should be removed from local parts at the point
4169where they are locally interpreted. [The new draft "821" is more explicit on
4170this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4171removing quoting backslashes and any unquoted doublequotes. */
4172
4173t = addr->cc_local_part = store_get(len+1);
4174while(len-- > 0)
4175 {
4176 register int c = *address++;
4177 if (c == '\"') continue;
4178 if (c == '\\')
4179 {
4180 *t++ = *address++;
4181 len--;
4182 }
4183 else *t++ = c;
4184 }
4185*t = 0;
4186
4187/* We do the percent hack only for those domains that are listed in
4188percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4189
4190if (percent_hack_domains != NULL)
4191 {
4192 int rc;
4193 uschar *new_address = NULL;
4194 uschar *local_part = addr->cc_local_part;
4195
4196 deliver_domain = addr->domain; /* set $domain */
4197
4198 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4199 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4200 == OK &&
4201 (t = Ustrrchr(local_part, '%')) != NULL)
4202 {
4203 new_address = string_copy(local_part);
4204 new_address[t - local_part] = '@';
4205 deliver_domain = string_copylc(t+1);
4206 local_part = string_copyn(local_part, t - local_part);
4207 }
4208
4209 if (rc == DEFER) return DEFER; /* lookup deferred */
4210
4211 /* If hackery happened, set up new parent and alter the current address. */
4212
4213 if (new_address != NULL)
4214 {
4215 address_item *new_parent = store_get(sizeof(address_item));
4216 *new_parent = *addr;
4217 addr->parent = new_parent;
4218 addr->address = new_address;
4219 addr->unique = string_copy(new_address);
4220 addr->domain = deliver_domain;
4221 addr->cc_local_part = local_part;
4222 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4223 addr->address);
4224 }
4225 }
4226
4227/* Create the lowercased version of the final local part, and make that the
4228default one to be used. */
4229
4230addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4231return OK;
4232}
4233
4234
4235
4236
4237/*************************************************
4238* Get next error message text *
4239*************************************************/
4240
4241/* If f is not NULL, read the next "paragraph", from a customized error message
4242text file, terminated by a line containing ****, and expand it.
4243
4244Arguments:
4245 f NULL or a file to read from
4246 which string indicating which string (for errors)
4247
4248Returns: NULL or an expanded string
4249*/
4250
4251static uschar *
4252next_emf(FILE *f, uschar *which)
4253{
4254int size = 256;
4255int ptr = 0;
4256uschar *para, *yield;
4257uschar buffer[256];
4258
4259if (f == NULL) return NULL;
4260
4261if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4262 Ustrcmp(buffer, "****\n") == 0) return NULL;
4263
4264para = store_get(size);
4265for (;;)
4266 {
4267 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4268 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4269 Ustrcmp(buffer, "****\n") == 0) break;
4270 }
4271para[ptr] = 0;
4272
4273yield = expand_string(para);
4274if (yield != NULL) return yield;
4275
4276log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4277 "bounce_message_file or warn_message_file (%s): %s", which,
4278 expand_string_message);
4279return NULL;
4280}
4281
4282
4283
4284
4285/*************************************************
4286* Close down a passed transport channel *
4287*************************************************/
4288
4289/* This function is called when a passed transport channel cannot be used.
4290It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4291so that the function call can be the argument of a "return" statement.
4292
4293Arguments: None
4294Returns: DELIVER_NOT_ATTEMPTED
4295*/
4296
4297static int
4298continue_closedown(void)
4299{
4300if (continue_transport != NULL)
4301 {
4302 transport_instance *t;
4303 for (t = transports; t != NULL; t = t->next)
4304 {
4305 if (Ustrcmp(t->name, continue_transport) == 0)
4306 {
4307 if (t->info->closedown != NULL) (t->info->closedown)(t);
4308 break;
4309 }
4310 }
4311 }
4312return DELIVER_NOT_ATTEMPTED;
4313}
4314
4315
4316
4317
4318/*************************************************
4319* Print address information *
4320*************************************************/
4321
4322/* This function is called to output an address, or information about an
4323address, for bounce or defer messages. If the hide_child flag is set, all we
4324output is the original ancestor address.
4325
4326Arguments:
4327 addr points to the address
4328 f the FILE to print to
4329 si an initial string
4330 sc a continuation string for before "generated"
4331 se an end string
4332
4333Returns: TRUE if the address is not hidden
4334*/
4335
4336static BOOL
4337print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4338 uschar *se)
4339{
4340BOOL yield = TRUE;
4341uschar *printed = US"";
4342address_item *ancestor = addr;
4343while (ancestor->parent != NULL) ancestor = ancestor->parent;
4344
4345fprintf(f, "%s", CS si);
4346
4347if (addr->parent != NULL && testflag(addr, af_hide_child))
4348 {
4349 printed = US"an undisclosed address";
4350 yield = FALSE;
4351 }
059ec3d9
PH
4352else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4353 printed = addr->address;
4354
4355else
4356 {
4357 uschar *s = addr->address;
4358 uschar *ss;
4359
4360 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4361 else if (addr->address[0] == '|') ss = US"pipe";
4362 else ss = US"save";
4363
4364 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4365 printed = addr->parent->address;
4366 }
4367
4368fprintf(f, "%s", CS string_printing(printed));
4369
4370if (ancestor != addr)
4371 {
4372 uschar *original = (ancestor->onetime_parent == NULL)?
4373 ancestor->address : ancestor->onetime_parent;
4374 if (strcmpic(original, printed) != 0)
4375 fprintf(f, "%s(%sgenerated from %s)", sc,
4376 (ancestor != addr->parent)? "ultimately " : "",
4377 string_printing(original));
4378 }
4379
4380fprintf(f, "%s", CS se);
4381return yield;
4382}
4383
4384
4385
4386
4387
059ec3d9
PH
4388/*************************************************
4389* Print error for an address *
4390*************************************************/
4391
4392/* This function is called to print the error information out of an address for
4393a bounce or a warning message. It tries to format the message reasonably by
4394introducing newlines. All lines are indented by 4; the initial printing
4395position must be set before calling.
4396
447d236c 4397This function used always to print the error. Nowadays we want to restrict it
75def545
PH
4398to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4399and filter "fail". We no longer pass other information willy-nilly in bounce
4400and warning messages. Text in user_message is always output; text in message
4401only if the af_pass_message flag is set.
447d236c 4402
059ec3d9 4403Arguments:
447d236c 4404 addr the address
059ec3d9 4405 f the FILE to print on
75def545 4406 t some leading text
059ec3d9
PH
4407
4408Returns: nothing
4409*/
4410
4411static void
447d236c 4412print_address_error(address_item *addr, FILE *f, uschar *t)
059ec3d9 4413{
447d236c 4414int count = Ustrlen(t);
75def545 4415uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
447d236c 4416
75def545 4417if (s == NULL)
059ec3d9 4418 {
75def545 4419 if (addr->user_message != NULL) s = addr->user_message; else return;
059ec3d9 4420 }
447d236c
PH
4421
4422fprintf(f, "\n %s", t);
4423
4424while (*s != 0)
059ec3d9 4425 {
447d236c
PH
4426 if (*s == '\\' && s[1] == 'n')
4427 {
4428 fprintf(f, "\n ");
4429 s += 2;
4430 count = 0;
4431 }
4432 else
059ec3d9 4433 {
447d236c
PH
4434 fputc(*s, f);
4435 count++;
4436 if (*s++ == ':' && isspace(*s) && count > 45)
059ec3d9 4437 {
447d236c 4438 fprintf(f, "\n "); /* sic (because space follows) */
059ec3d9
PH
4439 count = 0;
4440 }
059ec3d9
PH
4441 }
4442 }
4443}
4444
4445
4446
447d236c
PH
4447
4448
4449
d7174846
PH
4450/*************************************************
4451* Check list of addresses for duplication *
4452*************************************************/
4453
4454/* This function was introduced when the test for duplicate addresses that are
4455not pipes, files, or autoreplies was moved from the middle of routing to when
4456routing was complete. That was to fix obscure cases when the routing history
dbcef0ea
PH
4457affects the subsequent routing of identical addresses. This function is called
4458after routing, to check that the final routed addresses are not duplicates.
d7174846 4459
dbcef0ea
PH
4460If we detect a duplicate, we remember what it is a duplicate of. Note that
4461pipe, file, and autoreply de-duplication is handled during routing, so we must
4462leave such "addresses" alone here, as otherwise they will incorrectly be
4463discarded.
d7174846
PH
4464
4465Argument: address of list anchor
4466Returns: nothing
4467*/
4468
4469static void
4470do_duplicate_check(address_item **anchor)
4471{
4472address_item *addr;
4473while ((addr = *anchor) != NULL)
4474 {
4475 tree_node *tnode;
4476 if (testflag(addr, af_pfr))
4477 {
4478 anchor = &(addr->next);
4479 }
4480 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4481 {
4482 DEBUG(D_deliver|D_route)
4483 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4484 *anchor = addr->next;
4485 addr->dupof = tnode->data.ptr;
4486 addr->next = addr_duplicate;
4487 addr_duplicate = addr;
4488 }
4489 else
4490 {
4491 tree_add_duplicate(addr->unique, addr);
4492 anchor = &(addr->next);
4493 }
4494 }
4495}
4496
4497
4498
059ec3d9
PH
4499
4500/*************************************************
4501* Deliver one message *
4502*************************************************/
4503
4504/* This is the function which is called when a message is to be delivered. It
4505is passed the id of the message. It is possible that the message no longer
4506exists, if some other process has delivered it, and it is also possible that
4507the message is being worked on by another process, in which case the data file
4508will be locked.
4509
4510If no delivery is attempted for any of the above reasons, the function returns
4511DELIVER_NOT_ATTEMPTED.
4512
4513If the give_up flag is set true, do not attempt any deliveries, but instead
4514fail all outstanding addresses and return the message to the sender (or
4515whoever).
4516
4517A delivery operation has a process all to itself; we never deliver more than
4518one message in the same process. Therefore we needn't worry too much about
4519store leakage.
4520
4521Arguments:
4522 id the id of the message to be delivered
4523 forced TRUE if delivery was forced by an administrator; this overrides
4524 retry delays and causes a delivery to be tried regardless
4525 give_up TRUE if an administrator has requested that delivery attempts
4526 be abandoned
4527
4528Returns: When the global variable mua_wrapper is FALSE:
4529 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4530 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4531 When the global variable mua_wrapper is TRUE:
4532 DELIVER_MUA_SUCCEEDED if delivery succeeded
4533 DELIVER_MUA_FAILED if delivery failed
4534 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4535*/
4536
4537int
4538deliver_message(uschar *id, BOOL forced, BOOL give_up)
4539{
4540int i, rc;
4541int final_yield = DELIVER_ATTEMPTED_NORMAL;
4542time_t now = time(NULL);
4543address_item *addr_last = NULL;
4544uschar *filter_message = NULL;
4545FILE *jread;
4546int process_recipients = RECIP_ACCEPT;
4547open_db dbblock;
4548open_db *dbm_file;
faa05a93 4549extern int acl_where;
059ec3d9
PH
4550
4551uschar *info = (queue_run_pid == (pid_t)0)?
4552 string_sprintf("delivering %s", id) :
4553 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4554
4555/* If the D_process_info bit is on, set_process_info() will output debugging
4556information. If not, we want to show this initial information if D_deliver or
4557D_queue_run is set or in verbose mode. */
4558
4559set_process_info("%s", info);
4560
4561if ((debug_selector & D_process_info) == 0 &&
4562 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4563 debug_printf("%s\n", info);
4564
4565/* Ensure that we catch any subprocesses that are created. Although Exim
4566sets SIG_DFL as its initial default, some routes through the code end up
4567here with it set to SIG_IGN - cases where a non-synchronous delivery process
4568has been forked, but no re-exec has been done. We use sigaction rather than
4569plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4570sure it is turned off. (There was a problem on AIX with this.) */
4571
4572#ifdef SA_NOCLDWAIT
4573 {
4574 struct sigaction act;
4575 act.sa_handler = SIG_DFL;
4576 sigemptyset(&(act.sa_mask));
4577 act.sa_flags = 0;
4578 sigaction(SIGCHLD, &act, NULL);
4579 }
4580#else
4581signal(SIGCHLD, SIG_DFL);
4582#endif
4583
4584/* Make the forcing flag available for routers and transports, set up the
4585global message id field, and initialize the count for returned files and the
4586message size. This use of strcpy() is OK because the length id is checked when
4587it is obtained from a command line (the -M or -q options), and otherwise it is
4588known to be a valid message id. */
4589
4590Ustrcpy(message_id, id);
4591deliver_force = forced;
4592return_count = 0;
4593message_size = 0;
4594
4595/* Initialize some flags */
4596
4597update_spool = FALSE;
4598remove_journal = TRUE;
4599
faa05a93
JH
4600/* Set a known context for any ACLs we call via expansions */
4601acl_where = ACL_WHERE_DELIVERY;
4602
059ec3d9
PH
4603/* Reset the random number generator, so that if several delivery processes are
4604started from a queue runner that has already used random numbers (for sorting),
4605they don't all get the same sequence. */
4606
4607random_seed = 0;
4608
4609/* Open and lock the message's data file. Exim locks on this one because the
4610header file may get replaced as it is re-written during the delivery process.
4611Any failures cause messages to be written to the log, except for missing files
4612while queue running - another process probably completed delivery. As part of
4613opening the data file, message_subdir gets set. */
4614
4615if (!spool_open_datafile(id))
4616 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4617
4618/* The value of message_size at this point has been set to the data length,
4619plus one for the blank line that notionally precedes the data. */
4620
4621/* Now read the contents of the header file, which will set up the headers in
4622store, and also the list of recipients and the tree of non-recipients and
4623assorted flags. It updates message_size. If there is a reading or format error,
4624give up; if the message has been around for sufficiently long, remove it. */
4625
4626sprintf(CS spoolname, "%s-H", id);
4627if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4628 {
4629 if (errno == ERRNO_SPOOLFORMAT)
4630 {
4631 struct stat statbuf;
4632 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4633 spoolname);
4634 if (Ustat(big_buffer, &statbuf) == 0)
b1c749bb
PH
4635 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4636 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
059ec3d9
PH
4637 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4638 }
4639 else
4640 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4641 strerror(errno));
4642
4643 /* If we managed to read the envelope data, received_time contains the
4644 time the message was received. Otherwise, we can calculate it from the
4645 message id. */
4646
4647 if (rc != spool_read_hdrerror)
4648 {
4649 received_time = 0;
4650 for (i = 0; i < 6; i++)
4651 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4652 }
4653
4654 /* If we've had this malformed message too long, sling it. */
4655
4656 if (now - received_time > keep_malformed)
4657 {
4658 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4659 Uunlink(spoolname);
4660 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4661 Uunlink(spoolname);
4662 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4663 Uunlink(spoolname);
4664 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4665 Uunlink(spoolname);
4666 log_write(0, LOG_MAIN, "Message removed because older than %s",
4667 readconf_printtime(keep_malformed));
4668 }
4669
f1e894f3 4670 (void)close(deliver_datafile);
059ec3d9
PH
4671 deliver_datafile = -1;
4672 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4673 }
4674
4675/* The spool header file has been read. Look to see if there is an existing
4676journal file for this message. If there is, it means that a previous delivery
4677attempt crashed (program or host) before it could update the spool header file.
4678Read the list of delivered addresses from the journal and add them to the
4679nonrecipients tree. Then update the spool file. We can leave the journal in
4680existence, as it will get further successful deliveries added to it in this
4681run, and it will be deleted if this function gets to its end successfully.
4682Otherwise it might be needed again. */
4683
4684sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4685jread = Ufopen(spoolname, "rb");
4686if (jread != NULL)
4687 {
4688 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4689 {
4690 int n = Ustrlen(big_buffer);
4691 big_buffer[n-1] = 0;
4692 tree_add_nonrecipient(big_buffer);
4693 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4694 "journal file\n", big_buffer);
4695 }
f1e894f3 4696 (void)fclose(jread);
059ec3d9
PH
4697 /* Panic-dies on error */
4698 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4699 }
4700else if (errno != ENOENT)
4701 {
4702 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4703 "%s", strerror(errno));
4704 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4705 }
4706
4707/* A null recipients list indicates some kind of disaster. */
4708
4709if (recipients_list == NULL)
4710 {
f1e894f3 4711 (void)close(deliver_datafile);
059ec3d9
PH
4712 deliver_datafile = -1;
4713 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4714 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4715 }
4716
4717
4718/* Handle a message that is frozen. There are a number of different things that
4719can happen, but in the default situation, unless forced, no delivery is
4720attempted. */
4721
4722if (deliver_freeze)
4723 {
4724 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4725 /* Moving to another directory removes the message from Exim's view. Other
4726 tools must be used to deal with it. Logging of this action happens in
4727 spool_move_message() and its subfunctions. */
4728
4729 if (move_frozen_messages &&
4730 spool_move_message(id, message_subdir, US"", US"F"))
4731 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4732 #endif
4733
4734 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4735 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4736 flag causing all recipients to be failed. The time is the age of the
4737 message, not the time since freezing. */
4738
4739 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4740 {
4741 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4742 process_recipients = RECIP_FAIL_TIMEOUT;
4743 }
4744
4745 /* For bounce messages (and others with no sender), thaw if the error message
4746 ignore timer is exceeded. The message will be discarded if this delivery
4747 fails. */
4748
4749 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4750 {
4751 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4752 }
4753
ef213c3b
PH
4754 /* If this is a bounce message, or there's no auto thaw, or we haven't
4755 reached the auto thaw time yet, and this delivery is not forced by an admin
4756 user, do not attempt delivery of this message. Note that forced is set for
4757 continuing messages down the same channel, in order to skip load checking and
4758 ignore hold domains, but we don't want unfreezing in that case. */
059ec3d9
PH
4759
4760 else
4761 {
ef213c3b
PH
4762 if ((sender_address[0] == 0 ||
4763 auto_thaw <= 0 ||
4764 now <= deliver_frozen_at + auto_thaw
4765 )
4766 &&
4767 (!forced || !deliver_force_thaw || !admin_user ||
4768 continue_hostname != NULL
4769 ))
059ec3d9 4770 {
f1e894f3 4771 (void)close(deliver_datafile);
059ec3d9
PH
4772 deliver_datafile = -1;
4773 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4774 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4775 }
4776
4777 /* If delivery was forced (by an admin user), assume a manual thaw.
4778 Otherwise it's an auto thaw. */
4779
4780 if (forced)
4781 {
4782 deliver_manual_thaw = TRUE;
4783 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4784 }
4785 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4786 }
4787
4788 /* We get here if any of the rules for unfreezing have triggered. */
4789
4790 deliver_freeze = FALSE;
4791 update_spool = TRUE;
4792 }
4793
4794
4795/* Open the message log file if we are using them. This records details of
4796deliveries, deferments, and failures for the benefit of the mail administrator.
4797The log is not used by exim itself to track the progress of a message; that is
4798done by rewriting the header spool file. */
4799
4800if (message_logs)
4801 {
4802 uschar *error;
4803 int fd;
4804
4805 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4806 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
4807
4808 if (fd < 0)
4809 {
4810 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
4811 spoolname, strerror(errno));
4812 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4813 }
4814
4815 /* Make a C stream out of it. */
4816
4817 message_log = fdopen(fd, "a");
4818 if (message_log == NULL)
4819 {
4820 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
4821 spoolname, strerror(errno));
4822 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4823 }
4824 }
4825
4826
4827/* If asked to give up on a message, log who did it, and set the action for all
4828the addresses. */
4829
4830if (give_up)
4831 {
4832 struct passwd *pw = getpwuid(real_uid);
4833 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
4834 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
4835 process_recipients = RECIP_FAIL;
4836 }
4837
4838/* Otherwise, if there are too many Received: headers, fail all recipients. */
4839
4840else if (received_count > received_headers_max)
4841 process_recipients = RECIP_FAIL_LOOP;
4842
4843/* Otherwise, if a system-wide, address-independent message filter is
4844specified, run it now, except in the case when we are failing all recipients as
4845a result of timeout_frozen_after. If the system filter yields "delivered", then
4846ignore the true recipients of the message. Failure of the filter file is
4847logged, and the delivery attempt fails. */
4848
4849else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
4850 {
4851 int rc;
4852 int filtertype;
4853 ugid_block ugid;
4854 redirect_block redirect;
4855
4856 if (system_filter_uid_set)
4857 {
4858 ugid.uid = system_filter_uid;
4859 ugid.gid = system_filter_gid;
4860 ugid.uid_set = ugid.gid_set = TRUE;
4861 }
4862 else
4863 {
4864 ugid.uid_set = ugid.gid_set = FALSE;
4865 }
4866
4867 return_path = sender_address;
4868 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
4869 system_filtering = TRUE;
4870
4871 /* Any error in the filter file causes a delivery to be abandoned. */
4872
4873 redirect.string = system_filter;
4874 redirect.isfile = TRUE;
4875 redirect.check_owner = redirect.check_group = FALSE;
4876 redirect.owners = NULL;
4877 redirect.owngroups = NULL;
4878 redirect.pw = NULL;
4879 redirect.modemask = 0;
4880
4881 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
4882
4883 rc = rda_interpret(
4884 &redirect, /* Where the data is */
4885 RDO_DEFER | /* Turn on all the enabling options */
4886 RDO_FAIL | /* Leave off all the disabling options */
4887 RDO_FILTER |
4888 RDO_FREEZE |
4889 RDO_REALLOG |
4890 RDO_REWRITE,
4891 NULL, /* No :include: restriction (not used in filter) */
4892 NULL, /* No sieve vacation directory (not sieve!) */
efd9a422 4893 NULL, /* No sieve enotify mailto owner (not sieve!) */
e4a89c47
PH
4894 NULL, /* No sieve user address (not sieve!) */
4895 NULL, /* No sieve subaddress (not sieve!) */
059ec3d9
PH
4896 &ugid, /* uid/gid data */
4897 &addr_new, /* Where to hang generated addresses */
4898 &filter_message, /* Where to put error message */
4899 NULL, /* Don't skip syntax errors */
4900 &filtertype, /* Will always be set to FILTER_EXIM for this call */
4901 US"system filter"); /* For error messages */
4902
4903 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
4904
4905 if (rc == FF_ERROR || rc == FF_NONEXIST)
4906 {
f1e894f3 4907 (void)close(deliver_datafile);
059ec3d9
PH
4908 deliver_datafile = -1;
4909 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
4910 string_printing(filter_message));
4911 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4912 }
4913
4914 /* Reset things. If the filter message is an empty string, which can happen
4915 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
4916
4917 system_filtering = FALSE;
4918 enable_dollar_recipients = FALSE;
4919 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
4920
4921 /* Save the values of the system filter variables so that user filters
4922 can use them. */
4923
4924 memcpy(filter_sn, filter_n, sizeof(filter_sn));
4925
4926 /* The filter can request that delivery of the original addresses be
4927 deferred. */
4928
4929 if (rc == FF_DEFER)
4930 {
4931 process_recipients = RECIP_DEFER;
4932 deliver_msglog("Delivery deferred by system filter\n");
4933 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
4934 }
4935
4936 /* The filter can request that a message be frozen, but this does not
4937 take place if the message has been manually thawed. In that case, we must
4938 unset "delivered", which is forced by the "freeze" command to make -bF
4939 work properly. */
4940
4941 else if (rc == FF_FREEZE && !deliver_manual_thaw)
4942 {
4943 deliver_freeze = TRUE;
4944 deliver_frozen_at = time(NULL);
4945 process_recipients = RECIP_DEFER;
4946 frozen_info = string_sprintf(" by the system filter%s%s",
4947 (filter_message == NULL)? US"" : US": ",
4948 (filter_message == NULL)? US"" : filter_message);
4949 }
4950
4951 /* The filter can request that a message be failed. The error message may be
4952 quite long - it is sent back to the sender in the bounce - but we don't want
4953 to fill up the log with repetitions of it. If it starts with << then the text
4954 between << and >> is written to the log, with the rest left for the bounce
4955 message. */
4956
4957 else if (rc == FF_FAIL)
4958 {
4959 uschar *colon = US"";
4960 uschar *logmsg = US"";
4961 int loglen = 0;
4962
4963 process_recipients = RECIP_FAIL_FILTER;
4964
4965 if (filter_message != NULL)
4966 {
4967 uschar *logend;
4968 colon = US": ";
4969 if (filter_message[0] == '<' && filter_message[1] == '<' &&
4970 (logend = Ustrstr(filter_message, ">>")) != NULL)
4971 {
4972 logmsg = filter_message + 2;
4973 loglen = logend - logmsg;
4974 filter_message = logend + 2;
4975 if (filter_message[0] == 0) filter_message = NULL;
4976 }
4977 else
4978 {
4979 logmsg = filter_message;
4980 loglen = Ustrlen(filter_message);
4981 }
4982 }
4983
4984 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
4985 logmsg);
4986 }
4987
4988 /* Delivery can be restricted only to those recipients (if any) that the
4989 filter specified. */
4990
4991 else if (rc == FF_DELIVERED)
4992 {
4993 process_recipients = RECIP_IGNORE;
4994 if (addr_new == NULL)
4995 log_write(0, LOG_MAIN, "=> discarded (system filter)");
4996 else
4997 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
4998 }
4999
5000 /* If any new addresses were created by the filter, fake up a "parent"
5001 for them. This is necessary for pipes, etc., which are expected to have
5002 parents, and it also gives some sensible logging for others. Allow
5003 pipes, files, and autoreplies, and run them as the filter uid if set,
5004 otherwise as the current uid. */
5005
5006 if (addr_new != NULL)
5007 {
5008 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5009 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5010
5011 /* The text "system-filter" is tested in transport_set_up_command() and in
5012 set_up_shell_command() in the pipe transport, to enable them to permit
5013 $recipients, so don't change it here without also changing it there. */
5014
5015 address_item *p = addr_new;
5016 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5017
5018 parent->domain = string_copylc(qualify_domain_recipient);
5019 parent->local_part = US"system-filter";
5020
5021 /* As part of this loop, we arrange for addr_last to end up pointing
5022 at the final address. This is used if we go on to add addresses for the
5023 original recipients. */
5024
5025 while (p != NULL)
5026 {
4362ff0d
PH
5027 if (parent->child_count == SHRT_MAX)
5028 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5029 "than %d delivery addresses", SHRT_MAX);
059ec3d9
PH
5030 parent->child_count++;
5031 p->parent = parent;
5032
5033 if (testflag(p, af_pfr))
5034 {
5035 uschar *tpname;
5036 uschar *type;
5037 p->uid = uid;
5038 p->gid = gid;
5039 setflag(p, af_uid_set |
5040 af_gid_set |
5041 af_allow_file |
5042 af_allow_pipe |
5043 af_allow_reply);
5044
5045 /* Find the name of the system filter's appropriate pfr transport */
5046
5047 if (p->address[0] == '|')
5048 {
5049 type = US"pipe";
5050 tpname = system_filter_pipe_transport;
5051 address_pipe = p->address;
5052 }
5053 else if (p->address[0] == '>')
5054 {
5055 type = US"reply";
5056 tpname = system_filter_reply_transport;
5057 }
5058 else
5059 {
5060 if (p->address[Ustrlen(p->address)-1] == '/')
5061 {
5062 type = US"directory";
5063 tpname = system_filter_directory_transport;
5064 }
5065 else
5066 {
5067 type = US"file";
5068 tpname = system_filter_file_transport;
5069 }
5070 address_file = p->address;
5071 }
5072
5073 /* Now find the actual transport, first expanding the name. We have
5074 set address_file or address_pipe above. */
5075
5076 if (tpname != NULL)
5077 {
5078 uschar *tmp = expand_string(tpname);
5079 address_file = address_pipe = NULL;
5080 if (tmp == NULL)
5081 p->message = string_sprintf("failed to expand \"%s\" as a "
5082 "system filter transport name", tpname);
5083 tpname = tmp;
5084 }
5085 else
5086 {
5087 p->message = string_sprintf("system_filter_%s_transport is unset",
5088 type);
5089 }
5090
5091 if (tpname != NULL)
5092 {
5093 transport_instance *tp;
5094 for (tp = transports; tp != NULL; tp = tp->next)
5095 {
5096 if (Ustrcmp(tp->name, tpname) == 0)
5097 {
5098 p->transport = tp;
5099 break;
5100 }
5101 }
5102 if (tp == NULL)
5103 p->message = string_sprintf("failed to find \"%s\" transport "
5104 "for system filter delivery", tpname);
5105 }
5106
5107 /* If we couldn't set up a transport, defer the delivery, putting the
5108 error on the panic log as well as the main log. */
5109
5110 if (p->transport == NULL)
5111 {
5112 address_item *badp = p;
5113 p = p->next;
5114 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5115 badp->local_part = badp->address; /* Needed for log line */
5116 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5117 continue;
5118 }
5119 } /* End of pfr handling */
5120
5121 /* Either a non-pfr delivery, or we found a transport */
5122
5123 DEBUG(D_deliver|D_filter)
5124 debug_printf("system filter added %s\n", p->address);
5125
5126 addr_last = p;
5127 p = p->next;
5128 } /* Loop through all addr_new addresses */
5129 }
5130 }
5131
5132
5133/* Scan the recipients list, and for every one that is not in the non-
5134recipients tree, add an addr item to the chain of new addresses. If the pno
5135value is non-negative, we must set the onetime parent from it. This which
5136points to the relevant entry in the recipients list.
5137
5138This processing can be altered by the setting of the process_recipients
5139variable, which is changed if recipients are to be ignored, failed, or
5140deferred. This can happen as a result of system filter activity, or if the -Mg
5141option is used to fail all of them.
5142
5143Duplicate addresses are handled later by a different tree structure; we can't
5144just extend the non-recipients tree, because that will be re-written to the
5145spool if the message is deferred, and in any case there are casing
5146complications for local addresses. */
5147
5148if (process_recipients != RECIP_IGNORE)
5149 {
5150 for (i = 0; i < recipients_count; i++)
5151 {
5152 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5153 {
5154 recipient_item *r = recipients_list + i;
5155 address_item *new = deliver_make_addr(r->address, FALSE);
5156 new->p.errors_address = r->errors_to;
5157
5158 if (r->pno >= 0)
5159 new->onetime_parent = recipients_list[r->pno].address;
5160
5161 switch (process_recipients)
5162 {
5163 /* RECIP_DEFER is set when a system filter freezes a message. */
5164
5165 case RECIP_DEFER:
5166 new->next = addr_defer;
5167 addr_defer = new;
5168 break;
5169
5170
5171 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5172 command. */
5173
5174 case RECIP_FAIL_FILTER:
5175 new->message =
5176 (filter_message == NULL)? US"delivery cancelled" : filter_message;
447d236c 5177 setflag(new, af_pass_message);
059ec3d9
PH
5178 goto RECIP_QUEUE_FAILED; /* below */
5179
5180
5181 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5182 than the value in timeout_frozen_after. Treat non-bounce messages
5183 similarly to -Mg; for bounce messages we just want to discard, so
5184 don't put the address on the failed list. The timeout has already
5185 been logged. */
5186
5187 case RECIP_FAIL_TIMEOUT:
5188 new->message = US"delivery cancelled; message timed out";
5189 goto RECIP_QUEUE_FAILED; /* below */
5190
5191
5192 /* RECIP_FAIL is set when -Mg has been used. */
5193
5194 case RECIP_FAIL:
5195 new->message = US"delivery cancelled by administrator";
5196 /* Fall through */
5197
5198 /* Common code for the failure cases above. If this is not a bounce
5199 message, put the address on the failed list so that it is used to
5200 create a bounce. Otherwise do nothing - this just discards the address.
5201 The incident has already been logged. */
5202
5203 RECIP_QUEUE_FAILED:
5204 if (sender_address[0] != 0)
5205 {
5206 new->next = addr_failed;
5207 addr_failed = new;
5208 }
5209 break;
5210
5211
5212 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5213 in the message. Process each address as a routing failure; if this
5214 is a bounce message, it will get frozen. */
5215
5216 case RECIP_FAIL_LOOP:
5217 new->message = US"Too many \"Received\" headers - suspected mail loop";
5218 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5219 break;
5220
5221
5222 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5223
5224 default:
5225 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5226 addr_last = new;
5227 break;
5228 }
5229 }
5230 }
5231 }
5232
5233DEBUG(D_deliver)
5234 {
5235 address_item *p = addr_new;
5236 debug_printf("Delivery address list:\n");
5237 while (p != NULL)
5238 {
5239 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5240 p->onetime_parent);
5241 p = p->next;
5242 }
5243 }
5244
5245/* Set up the buffers used for copying over the file when delivering. */
5246
5247deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5248deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5249
5250
5251
5252/* Until there are no more new addresses, handle each one as follows:
5253
5254 . If this is a generated address (indicated by the presence of a parent
5255 pointer) then check to see whether it is a pipe, file, or autoreply, and
5256 if so, handle it directly here. The router that produced the address will
5257 have set the allow flags into the address, and also set the uid/gid required.
5258 Having the routers generate new addresses and then checking them here at
5259 the outer level is tidier than making each router do the checking, and
5260 means that routers don't need access to the failed address queue.
5261
5262 . Break up the address into local part and domain, and make lowercased
5263 versions of these strings. We also make unquoted versions of the local part.
5264
5265 . Handle the percent hack for those domains for which it is valid.
5266
5267 . For child addresses, determine if any of the parents have the same address.
5268 If so, generate a different string for previous delivery checking. Without
5269 this code, if the address spqr generates spqr via a forward or alias file,
5270 delivery of the generated spqr stops further attempts at the top level spqr,
5271 which is not what is wanted - it may have generated other addresses.
5272
5273 . Check on the retry database to see if routing was previously deferred, but
5274 only if in a queue run. Addresses that are to be routed are put on the
5275 addr_route chain. Addresses that are to be deferred are put on the
5276 addr_defer chain. We do all the checking first, so as not to keep the
5277 retry database open any longer than necessary.
5278
5279 . Now we run the addresses through the routers. A router may put the address
5280 on either the addr_local or the addr_remote chain for local or remote
5281 delivery, respectively, or put it on the addr_failed chain if it is
5282 undeliveable, or it may generate child addresses and put them on the
5283 addr_new chain, or it may defer an address. All the chain anchors are
5284 passed as arguments so that the routers can be called for verification
5285 purposes as well.
5286
5287 . If new addresses have been generated by the routers, da capo.
5288*/
5289
5290header_rewritten = FALSE; /* No headers rewritten yet */
5291while (addr_new != NULL) /* Loop until all addresses dealt with */
5292 {
5293 address_item *addr, *parent;
5294 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5295
5296 /* Failure to open the retry database is treated the same as if it does
5297 not exist. In both cases, dbm_file is NULL. */
5298
5299 if (dbm_file == NULL)
5300 {
5301 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5302 debug_printf("no retry data available\n");
5303 }
5304
5305 /* Scan the current batch of new addresses, to handle pipes, files and
5306 autoreplies, and determine which others are ready for routing. */
5307
5308 while (addr_new != NULL)
5309 {
5310 int rc;
5311 uschar *p;
5312 tree_node *tnode;
5313 dbdata_retry *domain_retry_record;
5314 dbdata_retry *address_retry_record;
5315
5316 addr = addr_new;
5317 addr_new = addr->next;
5318
5319 DEBUG(D_deliver|D_retry|D_route)
5320 {
5321 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5322 debug_printf("Considering: %s\n", addr->address);
5323 }
5324
5325 /* Handle generated address that is a pipe or a file or an autoreply. */
5326
5327 if (testflag(addr, af_pfr))
5328 {
424a1c63
PH
5329 /* If an autoreply in a filter could not generate a syntactically valid
5330 address, give up forthwith. Set af_ignore_error so that we don't try to
5331 generate a bounce. */
5332
5333 if (testflag(addr, af_bad_reply))
5334 {
5335 addr->basic_errno = ERRNO_BADADDRESS2;
5336 addr->local_part = addr->address;
5337 addr->message =
5338 US"filter autoreply generated syntactically invalid recipient";
5339 setflag(addr, af_ignore_error);
5340 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5341 continue; /* with the next new address */
5342 }
059ec3d9
PH
5343
5344 /* If two different users specify delivery to the same pipe or file or
5345 autoreply, there should be two different deliveries, so build a unique
5346 string that incorporates the original address, and use this for
5347 duplicate testing and recording delivery, and also for retrying. */
5348
5349 addr->unique =
424a1c63
PH
5350 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5351 (testflag(addr->parent, af_homonym)? 3:0));
059ec3d9
PH
5352
5353 addr->address_retry_key = addr->domain_retry_key =
5354 string_sprintf("T:%s", addr->unique);
5355
5356 /* If a filter file specifies two deliveries to the same pipe or file,
5357 we want to de-duplicate, but this is probably not wanted for two mail
5358 commands to the same address, where probably both should be delivered.
5359 So, we have to invent a different unique string in that case. Just
5360 keep piling '>' characters on the front. */
5361
5362 if (addr->address[0] == '>')
5363 {
5364 while (tree_search(tree_duplicates, addr->unique) != NULL)
5365 addr->unique = string_sprintf(">%s", addr->unique);
5366 }
5367
5368 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5369 {
5370 DEBUG(D_deliver|D_route)
5371 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5372 addr->dupof = tnode->data.ptr;
5373 addr->next = addr_duplicate;
5374 addr_duplicate = addr;
5375 continue;
5376 }
5377
5378 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5379
5380 /* Check for previous delivery */
5381
5382 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5383 {
5384 DEBUG(D_deliver|D_route)
5385 debug_printf("%s was previously delivered: discarded\n", addr->address);
5386 child_done(addr, tod_stamp(tod_log));
5387 continue;
5388 }
5389
5390 /* Save for checking future duplicates */
5391
5392 tree_add_duplicate(addr->unique, addr);
5393
5394 /* Set local part and domain */
5395
5396 addr->local_part = addr->address;
5397 addr->domain = addr->parent->domain;
5398
5399 /* Ensure that the delivery is permitted. */
5400
5401 if (testflag(addr, af_file))
5402 {
5403 if (!testflag(addr, af_allow_file))
5404 {
5405 addr->basic_errno = ERRNO_FORBIDFILE;
5406 addr->message = US"delivery to file forbidden";
5407 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5408 continue; /* with the next new address */
5409 }
5410 }
5411 else if (addr->address[0] == '|')
5412 {
5413 if (!testflag(addr, af_allow_pipe))
5414 {
5415 addr->basic_errno = ERRNO_FORBIDPIPE;
5416 addr->message = US"delivery to pipe forbidden";
5417 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5418 continue; /* with the next new address */
5419 }
5420 }
5421 else if (!testflag(addr, af_allow_reply))
5422 {
5423 addr->basic_errno = ERRNO_FORBIDREPLY;
5424 addr->message = US"autoreply forbidden";
5425 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5426 continue; /* with the next new address */
5427 }
5428
5429 /* If the errno field is already set to BADTRANSPORT, it indicates
5430 failure to expand a transport string, or find the associated transport,
5431 or an unset transport when one is required. Leave this test till now so
5432 that the forbid errors are given in preference. */
5433
5434 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5435 {
5436 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5437 continue;
5438 }
5439
5440 /* Treat /dev/null as a special case and abandon the delivery. This
5441 avoids having to specify a uid on the transport just for this case.
5442 Arrange for the transport name to be logged as "**bypassed**". */
5443
5444 if (Ustrcmp(addr->address, "/dev/null") == 0)
5445 {
5446 uschar *save = addr->transport->name;
5447 addr->transport->name = US"**bypassed**";
5448 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5449 addr->transport->name = save;
5450 continue; /* with the next new address */
5451 }
5452
5453 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5454 delivery. */
5455
5456 DEBUG(D_deliver|D_route)
5457 debug_printf("queued for %s transport\n", addr->transport->name);
5458 addr->next = addr_local;
5459 addr_local = addr;
5460 continue; /* with the next new address */
5461 }
5462
5463 /* Handle normal addresses. First, split up into local part and domain,
5464 handling the %-hack if necessary. There is the possibility of a defer from
5465 a lookup in percent_hack_domains. */
5466
5467 if ((rc = deliver_split_address(addr)) == DEFER)
5468 {
5469 addr->message = US"cannot check percent_hack_domains";
5470 addr->basic_errno = ERRNO_LISTDEFER;
5471 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5472 continue;
5473 }
5474
5475 /* Check to see if the domain is held. If so, proceed only if the
5476 delivery was forced by hand. */
5477
5478 deliver_domain = addr->domain; /* set $domain */
5479 if (!forced && hold_domains != NULL &&
5480 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5481 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5482 NULL)) != FAIL)
5483 {
5484 if (rc == DEFER)
5485 {
5486 addr->message = US"hold_domains lookup deferred";
5487 addr->basic_errno = ERRNO_LISTDEFER;
5488 }
5489 else
5490 {
5491 addr->message = US"domain is held";
5492 addr->basic_errno = ERRNO_HELD;
5493 }
5494 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5495 continue;
5496 }
5497
5498 /* Now we can check for duplicates and previously delivered addresses. In
5499 order to do this, we have to generate a "unique" value for each address,
5500 because there may be identical actual addresses in a line of descendents.
5501 The "unique" field is initialized to the same value as the "address" field,
5502 but gets changed here to cope with identically-named descendents. */
5503
5504 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5505 if (strcmpic(addr->address, parent->address) == 0) break;
5506
5507 /* If there's an ancestor with the same name, set the homonym flag. This
5508 influences how deliveries are recorded. Then add a prefix on the front of
5509 the unique address. We use \n\ where n starts at 0 and increases each time.
5510 It is unlikely to pass 9, but if it does, it may look odd but will still
5511 work. This means that siblings or cousins with the same names are treated
5512 as duplicates, which is what we want. */
5513
5514 if (parent != NULL)
5515 {
5516 setflag(addr, af_homonym);
5517 if (parent->unique[0] != '\\')
5518 addr->unique = string_sprintf("\\0\\%s", addr->address);
5519 else
5520 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5521 addr->address);
5522 }
5523
5524 /* Ensure that the domain in the unique field is lower cased, because
5525 domains are always handled caselessly. */
5526
5527 p = Ustrrchr(addr->unique, '@');
5528 while (*p != 0) { *p = tolower(*p); p++; }
5529
5530 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5531
5532 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5533 {
5534 DEBUG(D_deliver|D_route)
5535 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5536 child_done(addr, tod_stamp(tod_log));
5537 continue;
5538 }
5539
059ec3d9 5540 /* Get the routing retry status, saving the two retry keys (with and
48c7f9e2
PH
5541 without the local part) for subsequent use. If there is no retry record for
5542 the standard address routing retry key, we look for the same key with the
5543 sender attached, because this form is used by the smtp transport after a
5544 4xx response to RCPT when address_retry_include_sender is true. */
059ec3d9
PH
5545
5546 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5547 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5548 addr->domain);
5549
5550 if (dbm_file == NULL)
5551 domain_retry_record = address_retry_record = NULL;
5552 else
5553 {
5554 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5555 if (domain_retry_record != NULL &&
5556 now - domain_retry_record->time_stamp > retry_data_expire)
48c7f9e2 5557 domain_retry_record = NULL; /* Ignore if too old */
059ec3d9
PH
5558
5559 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5560 if (address_retry_record != NULL &&
5561 now - address_retry_record->time_stamp > retry_data_expire)
48c7f9e2
PH
5562 address_retry_record = NULL; /* Ignore if too old */
5563
5564 if (address_retry_record == NULL)
5565 {
09945f1e 5566 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
48c7f9e2
PH
5567 sender_address);
5568 address_retry_record = dbfn_read(dbm_file, altkey);
5569 if (address_retry_record != NULL &&
5570 now - address_retry_record->time_stamp > retry_data_expire)
5571 address_retry_record = NULL; /* Ignore if too old */
5572 }
059ec3d9
PH
5573 }
5574
5575 DEBUG(D_deliver|D_retry)
5576 {
5577 if (domain_retry_record == NULL)
5578 debug_printf("no domain retry record\n");
5579 if (address_retry_record == NULL)
5580 debug_printf("no address retry record\n");
5581 }
5582
5583 /* If we are sending a message down an existing SMTP connection, we must
5584 assume that the message which created the connection managed to route
5585 an address to that connection. We do not want to run the risk of taking
5586 a long time over routing here, because if we do, the server at the other
5587 end of the connection may time it out. This is especially true for messages
5588 with lots of addresses. For this kind of delivery, queue_running is not
5589 set, so we would normally route all addresses. We take a pragmatic approach
5590 and defer routing any addresses that have any kind of domain retry record.
5591 That is, we don't even look at their retry times. It doesn't matter if this
5592 doesn't work occasionally. This is all just an optimization, after all.
5593
5594 The reason for not doing the same for address retries is that they normally
5595 arise from 4xx responses, not DNS timeouts. */
5596
5597 if (continue_hostname != NULL && domain_retry_record != NULL)
5598 {
5599 addr->message = US"reusing SMTP connection skips previous routing defer";
5600 addr->basic_errno = ERRNO_RRETRY;
5601 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5602 }
5603
f6c332bd
PH
5604 /* If we are in a queue run, defer routing unless there is no retry data or
5605 we've passed the next retry time, or this message is forced. In other
5606 words, ignore retry data when not in a queue run.
5607
5608 However, if the domain retry time has expired, always allow the routing
5609 attempt. If it fails again, the address will be failed. This ensures that
059ec3d9
PH
5610 each address is routed at least once, even after long-term routing
5611 failures.
5612
5613 If there is an address retry, check that too; just wait for the next
5614 retry time. This helps with the case when the temporary error on the
5615 address was really message-specific rather than address specific, since
f6c332bd
PH
5616 it allows other messages through.
5617
5618 We also wait for the next retry time if this is a message sent down an
5619 existing SMTP connection (even though that will be forced). Otherwise there
5620 will be far too many attempts for an address that gets a 4xx error. In
5621 fact, after such an error, we should not get here because, the host should
5622 not be remembered as one this message needs. However, there was a bug that
ba9af0af
TF
5623 used to cause this to happen, so it is best to be on the safe side.
5624
5625 Even if we haven't reached the retry time in the hints, there is one
5626 more check to do, which is for the ultimate address timeout. */
059ec3d9 5627
f6c332bd
PH
5628 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5629 &&
059ec3d9
PH
5630 ((domain_retry_record != NULL &&
5631 now < domain_retry_record->next_try &&
5632 !domain_retry_record->expired)
5633 ||
5634 (address_retry_record != NULL &&
5635 now < address_retry_record->next_try))
ba9af0af
TF
5636 &&
5637 !retry_ultimate_address_timeout(addr->address_retry_key,
5638 addr->domain, address_retry_record, now)
059ec3d9
PH
5639 )
5640 {
5641 addr->message = US"retry time not reached";
5642 addr->basic_errno = ERRNO_RRETRY;
5643 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5644 }
5645
5646 /* The domain is OK for routing. Remember if retry data exists so it
5647 can be cleaned up after a successful delivery. */
5648
5649 else
5650 {
5651 if (domain_retry_record != NULL || address_retry_record != NULL)
5652 setflag(addr, af_dr_retry_exists);
5653 addr->next = addr_route;
5654 addr_route = addr;
5655 DEBUG(D_deliver|D_route)
5656 debug_printf("%s: queued for routing\n", addr->address);
5657 }
5658 }
5659
5660 /* The database is closed while routing is actually happening. Requests to
5661 update it are put on a chain and all processed together at the end. */
5662
5663 if (dbm_file != NULL) dbfn_close(dbm_file);
5664
5665 /* If queue_domains is set, we don't even want to try routing addresses in
5666 those domains. During queue runs, queue_domains is forced to be unset.
5667 Optimize by skipping this pass through the addresses if nothing is set. */
5668
5669 if (!deliver_force && queue_domains != NULL)
5670 {
5671 address_item *okaddr = NULL;
5672 while (addr_route != NULL)
5673 {
5674 address_item *addr = addr_route;
5675 addr_route = addr->next;
5676
5677 deliver_domain = addr->domain; /* set $domain */
5678 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5679 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5680 != OK)
5681 {
5682 if (rc == DEFER)
5683 {
5684 addr->basic_errno = ERRNO_LISTDEFER;
5685 addr->message = US"queue_domains lookup deferred";
5686 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5687 }
5688 else
5689 {
5690 addr->next = okaddr;
5691 okaddr = addr;
5692 }
5693 }
5694 else
5695 {
5696 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5697 addr->message = US"domain is in queue_domains";
5698 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5699 }
5700 }
5701
5702 addr_route = okaddr;
5703 }
5704
5705 /* Now route those addresses that are not deferred. */
5706
5707 while (addr_route != NULL)
5708 {
5709 int rc;
5710 address_item *addr = addr_route;
5711 uschar *old_domain = addr->domain;
5712 uschar *old_unique = addr->unique;
5713 addr_route = addr->next;
5714 addr->next = NULL;
5715
5716 /* Just in case some router parameter refers to it. */
5717
5718 return_path = (addr->p.errors_address != NULL)?
5719 addr->p.errors_address : sender_address;
5720
5721 /* If a router defers an address, add a retry item. Whether or not to
5722 use the local part in the key is a property of the router. */
5723
5724 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5725 &addr_succeed, v_none)) == DEFER)
5726 retry_add_item(addr, (addr->router->retry_use_local_part)?
5727 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5728 string_sprintf("R:%s", addr->domain), 0);
5729
5730 /* Otherwise, if there is an existing retry record in the database, add
09945f1e
PH
5731 retry items to delete both forms. We must also allow for the possibility
5732 of a routing retry that includes the sender address. Since the domain might
5733 have been rewritten (expanded to fully qualified) as a result of routing,
5734 ensure that the rewritten form is also deleted. */
059ec3d9
PH
5735
5736 else if (testflag(addr, af_dr_retry_exists))
5737 {
09945f1e
PH
5738 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5739 sender_address);
5740 retry_add_item(addr, altkey, rf_delete);
059ec3d9
PH
5741 retry_add_item(addr, addr->address_retry_key, rf_delete);
5742 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5743 if (Ustrcmp(addr->domain, old_domain) != 0)
5744 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5745 }
5746
5747 /* DISCARD is given for :blackhole: and "seen finish". The event has been
5748 logged, but we need to ensure the address (and maybe parents) is marked
5749 done. */
5750
5751 if (rc == DISCARD)
5752 {
5753 address_done(addr, tod_stamp(tod_log));
5754 continue; /* route next address */
5755 }
5756
5757 /* The address is finished with (failed or deferred). */
5758
5759 if (rc != OK)
5760 {
5761 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5762 continue; /* route next address */
5763 }
5764
5765 /* The address has been routed. If the router changed the domain, it will
5766 also have changed the unique address. We have to test whether this address
5767 has already been delivered, because it's the unique address that finally
5768 gets recorded. */
5769
5770 if (addr->unique != old_unique &&
5771 tree_search(tree_nonrecipients, addr->unique) != 0)
5772 {
5773 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5774 "discarded\n", addr->address);
5775 if (addr_remote == addr) addr_remote = addr->next;
5776 else if (addr_local == addr) addr_local = addr->next;
5777 }
5778
5779 /* If the router has same_domain_copy_routing set, we are permitted to copy
5780 the routing for any other addresses with the same domain. This is an
5781 optimisation to save repeated DNS lookups for "standard" remote domain
5782 routing. The option is settable only on routers that generate host lists.
5783 We play it very safe, and do the optimization only if the address is routed
5784 to a remote transport, there are no header changes, and the domain was not
5785 modified by the router. */
5786
5787 if (addr_remote == addr &&
5788 addr->router->same_domain_copy_routing &&
5789 addr->p.extra_headers == NULL &&
5790 addr->p.remove_headers == NULL &&
5791 old_domain == addr->domain)
5792 {
5793 address_item **chain = &addr_route;
5794 while (*chain != NULL)
5795 {
5796 address_item *addr2 = *chain;
5797 if (Ustrcmp(addr2->domain, addr->domain) != 0)
5798 {
5799 chain = &(addr2->next);
5800 continue;
5801 }
5802
5803 /* Found a suitable address; take it off the routing list and add it to
5804 the remote delivery list. */
5805
5806 *chain = addr2->next;
5807 addr2->next = addr_remote;
5808 addr_remote = addr2;
5809
5810 /* Copy the routing data */
5811
5812 addr2->domain = addr->domain;
5813 addr2->router = addr->router;
5814 addr2->transport = addr->transport;
5815 addr2->host_list = addr->host_list;
5816 addr2->fallback_hosts = addr->fallback_hosts;
5817 addr2->p.errors_address = addr->p.errors_address;
5818 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
5819
5820 DEBUG(D_deliver|D_route)
5821 {
5822 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
5823 "routing %s\n"
5824 "Routing for %s copied from %s\n",
5825 addr2->address, addr2->address, addr->address);
5826 }
5827 }
5828 }
5829 } /* Continue with routing the next address. */
5830 } /* Loop to process any child addresses that the routers created, and
5831 any rerouted addresses that got put back on the new chain. */
5832
5833
5834/* Debugging: show the results of the routing */
5835
5836DEBUG(D_deliver|D_retry|D_route)
5837 {
5838 address_item *p = addr_local;
5839 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5840 debug_printf("After routing:\n Local deliveries:\n");
5841 while (p != NULL)
5842 {
5843 debug_printf(" %s\n", p->address);
5844 p = p->next;
5845 }
5846
5847 p = addr_remote;
5848 debug_printf(" Remote deliveries:\n");
5849 while (p != NULL)
5850 {
5851 debug_printf(" %s\n", p->address);
5852 p = p->next;
5853 }
5854
5855 p = addr_failed;
5856 debug_printf(" Failed addresses:\n");
5857 while (p != NULL)
5858 {
5859 debug_printf(" %s\n", p->address);
5860 p = p->next;
5861 }
5862
5863 p = addr_defer;
5864 debug_printf(" Deferred addresses:\n");
5865 while (p != NULL)
5866 {
5867 debug_printf(" %s\n", p->address);
5868 p = p->next;
5869 }
5870 }
5871
5872/* Free any resources that were cached during routing. */
5873
5874search_tidyup();
5875route_tidyup();
5876
5877/* These two variables are set only during routing, after check_local_user.
5878Ensure they are not set in transports. */
5879
5880local_user_gid = (gid_t)(-1);
5881local_user_uid = (uid_t)(-1);
5882
d7174846
PH
5883/* Check for any duplicate addresses. This check is delayed until after
5884routing, because the flexibility of the routing configuration means that
5885identical addresses with different parentage may end up being redirected to
5886different addresses. Checking for duplicates too early (as we previously used
5887to) makes this kind of thing not work. */
5888
5889do_duplicate_check(&addr_local);
5890do_duplicate_check(&addr_remote);
5891
059ec3d9
PH
5892/* When acting as an MUA wrapper, we proceed only if all addresses route to a
5893remote transport. The check that they all end up in one transaction happens in
5894the do_remote_deliveries() function. */
5895
5896if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
5897 addr_defer != NULL))
5898 {
5899 address_item *addr;
5900 uschar *which, *colon, *msg;
5901
5902 if (addr_local != NULL)
5903 {
5904 addr = addr_local;
5905 which = US"local";
5906 }
5907 else if (addr_defer != NULL)
5908 {
5909 addr = addr_defer;
5910 which = US"deferred";
5911 }
5912 else
5913 {
5914 addr = addr_failed;
5915 which = US"failed";
5916 }
5917
5918 while (addr->parent != NULL) addr = addr->parent;
5919
5920 if (addr->message != NULL)
5921 {
5922 colon = US": ";
5923 msg = addr->message;
5924 }
5925 else colon = msg = US"";
5926
5927 /* We don't need to log here for a forced failure as it will already
5928 have been logged. Defer will also have been logged, but as a defer, so we do
5929 need to do the failure logging. */
5930
5931 if (addr != addr_failed)
5932 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
5933 addr->address, which);
5934
5935 /* Always write an error to the caller */
5936
5937 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
5938 which, colon, msg);
5939
5940 final_yield = DELIVER_MUA_FAILED;
5941 addr_failed = addr_defer = NULL; /* So that we remove the message */
5942 goto DELIVERY_TIDYUP;
5943 }
5944
5945
5946/* If this is a run to continue deliveries to an external channel that is
5947already set up, defer any local deliveries. */
5948
5949if (continue_transport != NULL)
5950 {
5951 if (addr_defer == NULL) addr_defer = addr_local; else
5952 {
5953 address_item *addr = addr_defer;
5954 while (addr->next != NULL) addr = addr->next;
5955 addr->next = addr_local;
5956 }
5957 addr_local = NULL;
5958 }
5959
5960
5961/* Because address rewriting can happen in the routers, we should not really do
5962ANY deliveries until all addresses have been routed, so that all recipients of
5963the message get the same headers. However, this is in practice not always
5964possible, since sometimes remote addresses give DNS timeouts for days on end.
5965The pragmatic approach is to deliver what we can now, saving any rewritten
5966headers so that at least the next lot of recipients benefit from the rewriting
5967that has already been done.
5968
5969If any headers have been rewritten during routing, update the spool file to
5970remember them for all subsequent deliveries. This can be delayed till later if
5971there is only address to be delivered - if it succeeds the spool write need not
5972happen. */
5973
5974if (header_rewritten &&
5975 ((addr_local != NULL &&
5976 (addr_local->next != NULL || addr_remote != NULL)) ||
5977 (addr_remote != NULL && addr_remote->next != NULL)))
5978 {
5979 /* Panic-dies on error */
5980 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5981 header_rewritten = FALSE;
5982 }
5983
5984
5985/* If there are any deliveries to be done, open the journal file. This is used
5986to record successful deliveries as soon as possible after each delivery is
5987known to be complete. A file opened with O_APPEND is used so that several
5988processes can run simultaneously.
5989
5990The journal is just insurance against crashes. When the spool file is
5991ultimately updated at the end of processing, the journal is deleted. If a
5992journal is found to exist at the start of delivery, the addresses listed
5993therein are added to the non-recipients. */
5994
5995if (addr_local != NULL || addr_remote != NULL)
5996 {
5997 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5998 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
5999
6000 if (journal_fd < 0)
6001 {
6002 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6003 spoolname, strerror(errno));
6004 return DELIVER_NOT_ATTEMPTED;
6005 }
6006
6007 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6008 that the mode is correct - the group setting doesn't always seem to get
6009 set automatically. */
6010
1ac6b2e7
JH
6011 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6012 || fchown(journal_fd, exim_uid, exim_gid)
6013 || fchmod(journal_fd, SPOOL_MODE)
6014 )
6015 {
6016 int ret = Uunlink(spoolname);
6017 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6018 spoolname, strerror(errno));
6019 if(ret && errno != ENOENT)
6020 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6021 spoolname, strerror(errno));
6022 return DELIVER_NOT_ATTEMPTED;
6023 }
059ec3d9
PH
6024 }
6025
6026
1ac6b2e7 6027
059ec3d9
PH
6028/* Now we can get down to the business of actually doing deliveries. Local
6029deliveries are done first, then remote ones. If ever the problems of how to
6030handle fallback transports are figured out, this section can be put into a loop
6031for handling fallbacks, though the uid switching will have to be revised. */
6032
f1513293
PH
6033/* Precompile a regex that is used to recognize a parameter in response
6034to an LHLO command, if is isn't already compiled. This may be used on both
6035local and remote LMTP deliveries. */
6036
6037if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6038 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6039
6040/* Handle local deliveries */
6041
059ec3d9
PH
6042if (addr_local != NULL)
6043 {
6044 DEBUG(D_deliver|D_transport)
6045 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6046 do_local_deliveries();
6047 disable_logging = FALSE;
6048 }
6049
6050/* If queue_run_local is set, we do not want to attempt any remote deliveries,
6051so just queue them all. */
6052
6053if (queue_run_local)
6054 {
6055 while (addr_remote != NULL)
6056 {
6057 address_item *addr = addr_remote;
6058 addr_remote = addr->next;
6059 addr->next = NULL;
6060 addr->basic_errno = ERRNO_LOCAL_ONLY;
6061 addr->message = US"remote deliveries suppressed";
6062 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6063 }
6064 }
6065
6066/* Handle remote deliveries */
6067
6068if (addr_remote != NULL)
6069 {
6070 DEBUG(D_deliver|D_transport)
6071 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6072
6073 /* Precompile some regex that are used to recognize parameters in response
6074 to an EHLO command, if they aren't already compiled. */
6075
6076 if (regex_PIPELINING == NULL) regex_PIPELINING =
6077 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
6078
6079 if (regex_SIZE == NULL) regex_SIZE =
6080 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
6081
6082 if (regex_AUTH == NULL) regex_AUTH =
6083 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
6084 FALSE, TRUE);
6085
6086 #ifdef SUPPORT_TLS
6087 if (regex_STARTTLS == NULL) regex_STARTTLS =
6088 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
6089 #endif
6090
6091 /* Now sort the addresses if required, and do the deliveries. The yield of
6092 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6093 cannot be delivered in one transaction. */
6094
6095 if (remote_sort_domains != NULL) sort_remote_deliveries();
6096 if (!do_remote_deliveries(FALSE))
6097 {
6098 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6099 "be delivered in one transaction");
6100 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6101
6102 final_yield = DELIVER_MUA_FAILED;
6103 addr_failed = addr_defer = NULL; /* So that we remove the message */
6104 goto DELIVERY_TIDYUP;
6105 }
6106
6107 /* See if any of the addresses that failed got put on the queue for delivery
6108 to their fallback hosts. We do it this way because often the same fallback
6109 host is used for many domains, so all can be sent in a single transaction
6110 (if appropriately configured). */
6111
6112 if (addr_fallback != NULL && !mua_wrapper)
6113 {
6114 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6115 addr_remote = addr_fallback;
6116 addr_fallback = NULL;
6117 if (remote_sort_domains != NULL) sort_remote_deliveries();
6118 do_remote_deliveries(TRUE);
6119 }
6120 disable_logging = FALSE;
6121 }
6122
6123
6124/* All deliveries are now complete. Ignore SIGTERM during this tidying up
6125phase, to minimize cases of half-done things. */
6126
6127DEBUG(D_deliver)
6128 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6129
6130/* Root privilege is no longer needed */
6131
6132exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6133
6134set_process_info("tidying up after delivering %s", message_id);
6135signal(SIGTERM, SIG_IGN);
6136
6137/* When we are acting as an MUA wrapper, the smtp transport will either have
47c7a64a
PH
6138succeeded for all addresses, or failed them all in normal cases. However, there
6139are some setup situations (e.g. when a named port does not exist) that cause an
6140immediate exit with deferral of all addresses. Convert those into failures. We
6141do not ever want to retry, nor do we want to send a bounce message. */
059ec3d9
PH
6142
6143if (mua_wrapper)
6144 {
47c7a64a
PH
6145 if (addr_defer != NULL)
6146 {
6147 address_item *addr, *nextaddr;
6148 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6149 {
6150 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6151 "delivery", addr->address);
6152 nextaddr = addr->next;
6153 addr->next = addr_failed;
6154 addr_failed = addr;
6155 }
6156 addr_defer = NULL;
6157 }
6158
6159 /* Now all should either have succeeded or failed. */
6160
059ec3d9
PH
6161 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6162 {
6163 uschar *s = (addr_failed->user_message != NULL)?
6164 addr_failed->user_message : addr_failed->message;
6165
6166 fprintf(stderr, "Delivery failed: ");
6167 if (addr_failed->basic_errno > 0)
6168 {
6169 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6170 if (s != NULL) fprintf(stderr, ": ");
6171 }
6172 if (s == NULL)
6173 {
6174 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6175 }
6176 else fprintf(stderr, "%s", CS s);
6177 fprintf(stderr, "\n");
6178
6179 final_yield = DELIVER_MUA_FAILED;
6180 addr_failed = NULL;
6181 }
6182 }
6183
6184/* In a normal configuration, we now update the retry database. This is done in
6185one fell swoop at the end in order not to keep opening and closing (and
6186locking) the database. The code for handling retries is hived off into a
6187separate module for convenience. We pass it the addresses of the various
6188chains, because deferred addresses can get moved onto the failed chain if the
6189retry cutoff time has expired for all alternative destinations. Bypass the
6190updating of the database if the -N flag is set, which is a debugging thing that
6191prevents actual delivery. */
6192
6193else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6194
6195/* If any addresses failed, we must send a message to somebody, unless
6196af_ignore_error is set, in which case no action is taken. It is possible for
6197several messages to get sent if there are addresses with different
6198requirements. */
6199
6200while (addr_failed != NULL)
6201 {
6202 pid_t pid;
6203 int fd;
6204 uschar *logtod = tod_stamp(tod_log);
6205 address_item *addr;
6206 address_item *handled_addr = NULL;
6207 address_item **paddr;
6208 address_item *msgchain = NULL;
6209 address_item **pmsgchain = &msgchain;
6210
6211 /* There are weird cases when logging is disabled in the transport. However,
6212 there may not be a transport (address failed by a router). */
6213
6214 disable_logging = FALSE;
6215 if (addr_failed->transport != NULL)
6216 disable_logging = addr_failed->transport->disable_logging;
6217
6218 DEBUG(D_deliver)
6219 debug_printf("processing failed address %s\n", addr_failed->address);
6220
6221 /* There are only two ways an address in a bounce message can get here:
6222
6223 (1) When delivery was initially deferred, but has now timed out (in the call
6224 to retry_update() above). We can detect this by testing for
6225 af_retry_timedout. If the address does not have its own errors address,
6226 we arrange to ignore the error.
6227
6228 (2) If delivery failures for bounce messages are being ignored. We can detect
6229 this by testing for af_ignore_error. This will also be set if a bounce
6230 message has been autothawed and the ignore_bounce_errors_after time has
6231 passed. It might also be set if a router was explicitly configured to
6232 ignore errors (errors_to = "").
6233
6234 If neither of these cases obtains, something has gone wrong. Log the
6235 incident, but then ignore the error. */
6236
6237 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6238 {
6239 if (!testflag(addr_failed, af_retry_timedout) &&
6240 !testflag(addr_failed, af_ignore_error))
6241 {
6242 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6243 "failure is neither frozen nor ignored (it's been ignored)");
6244 }
6245 setflag(addr_failed, af_ignore_error);
6246 }
6247
6248 /* If the first address on the list has af_ignore_error set, just remove
6249 it from the list, throw away any saved message file, log it, and
6250 mark the recipient done. */
6251
6252 if (testflag(addr_failed, af_ignore_error))
6253 {
6254 addr = addr_failed;
6255 addr_failed = addr->next;
6256 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6257
6258 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6259 addr->address,
6260 (addr->parent == NULL)? US"" : US" <",
6261 (addr->parent == NULL)? US"" : addr->parent->address,
6262 (addr->parent == NULL)? US"" : US">");
6263
6264 address_done(addr, logtod);
6265 child_done(addr, logtod);
6266 /* Panic-dies on error */
6267 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6268 }
6269
6270 /* Otherwise, handle the sending of a message. Find the error address for
6271 the first address, then send a message that includes all failed addresses
6272 that have the same error address. Note the bounce_recipient is a global so
6273 that it can be accesssed by $bounce_recipient while creating a customized
6274 error message. */
6275
6276 else
6277 {
6278 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6279 sender_address : addr_failed->p.errors_address;
6280
6281 /* Make a subprocess to send a message */
6282
6283 pid = child_open_exim(&fd);
6284
6285 /* Creation of child failed */
6286
6287 if (pid < 0)
6288 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6289 "create child process to send failure message: %s", getpid(),
6290 getppid(), strerror(errno));
6291
6292 /* Creation of child succeeded */
6293
6294 else
6295 {
6296 int ch, rc;
6297 int filecount = 0;
6298 int rcount = 0;
6299 uschar *bcc, *emf_text;
6300 FILE *f = fdopen(fd, "wb");
6301 FILE *emf = NULL;
6302 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6303 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6304 DELIVER_IN_BUFFER_SIZE;
6305
6306 DEBUG(D_deliver)
6307 debug_printf("sending error message to: %s\n", bounce_recipient);
6308
6309 /* Scan the addresses for all that have the same errors address, removing
6310 them from the addr_failed chain, and putting them on msgchain. */
6311
6312 paddr = &addr_failed;
6313 for (addr = addr_failed; addr != NULL; addr = *paddr)
6314 {
6315 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6316 sender_address : addr->p.errors_address) != 0)
6317 {
6318 paddr = &(addr->next); /* Not the same; skip */
6319 }
6320 else /* The same - dechain */
6321 {
6322 *paddr = addr->next;
6323 *pmsgchain = addr;
6324 addr->next = NULL;
6325 pmsgchain = &(addr->next);
6326 }
6327 }
6328
6329 /* Include X-Failed-Recipients: for automatic interpretation, but do
6330 not let any one header line get too long. We do this by starting a
6331 new header every 50 recipients. Omit any addresses for which the
6332 "hide_child" flag is set. */
6333
6334 for (addr = msgchain; addr != NULL; addr = addr->next)
6335 {
6336 if (testflag(addr, af_hide_child)) continue;
6337 if (rcount >= 50)
6338 {
6339 fprintf(f, "\n");
6340 rcount = 0;
6341 }
6342 fprintf(f, "%s%s",
6343 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6344 (testflag(addr, af_pfr) && addr->parent != NULL)?
6345 string_printing(addr->parent->address) :
6346 string_printing(addr->address));
6347 }
6348 if (rcount > 0) fprintf(f, "\n");
6349
6350 /* Output the standard headers */
6351
6352 if (errors_reply_to != NULL)
6353 fprintf(f, "Reply-To: %s\n", errors_reply_to);
456682f5 6354 fprintf(f, "Auto-Submitted: auto-replied\n");
0e22dfd1 6355 moan_write_from(f);
059ec3d9
PH
6356 fprintf(f, "To: %s\n", bounce_recipient);
6357
6358 /* Open a template file if one is provided. Log failure to open, but
6359 carry on - default texts will be used. */
6360
6361 if (bounce_message_file != NULL)
6362 {
6363 emf = Ufopen(bounce_message_file, "rb");
6364 if (emf == NULL)
6365 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6366 "message texts: %s", bounce_message_file, strerror(errno));
6367 }
6368
6369 /* Quietly copy to configured additional addresses if required. */
6370
6371 bcc = moan_check_errorcopy(bounce_recipient);
6372 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6373
6374 /* The texts for the message can be read from a template file; if there
6375 isn't one, or if it is too short, built-in texts are used. The first
6376 emf text is a Subject: and any other headers. */
6377
6378 emf_text = next_emf(emf, US"header");
6379 if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6380 {
6381 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6382 to_sender? ": returning message to sender" : "");
6383 }
6384
6385 emf_text = next_emf(emf, US"intro");
6386 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6387 {
6388 fprintf(f,
6389/* This message has been reworded several times. It seems to be confusing to
6390somebody, however it is worded. I have retreated to the original, simple
6391wording. */
6392"This message was created automatically by mail delivery software.\n");
6393 if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6394 if (to_sender)
6395 {
6396 fprintf(f,
6397"\nA message that you sent could not be delivered to one or more of its\n"
6398"recipients. This is a permanent error. The following address(es) failed:\n");
6399 }
6400 else
6401 {
6402 fprintf(f,
6403"\nA message sent by\n\n <%s>\n\n"
6404"could not be delivered to one or more of its recipients. The following\n"
6405"address(es) failed:\n", sender_address);
6406 }
6407 }
6408 fprintf(f, "\n");
6409
6410 /* Process the addresses, leaving them on the msgchain if they have a
6411 file name for a return message. (There has already been a check in
447d236c
PH
6412 post_process_one() for the existence of data in the message file.) A TRUE
6413 return from print_address_information() means that the address is not
6414 hidden. */
059ec3d9
PH
6415
6416 paddr = &msgchain;
6417 for (addr = msgchain; addr != NULL; addr = *paddr)
6418 {
6419 if (print_address_information(addr, f, US" ", US"\n ", US""))
447d236c 6420 print_address_error(addr, f, US"");
059ec3d9
PH
6421
6422 /* End the final line for the address */
6423
6424 fputc('\n', f);
6425
6426 /* Leave on msgchain if there's a return file. */
6427
6428 if (addr->return_file >= 0)
6429 {
6430 paddr = &(addr->next);
6431 filecount++;
6432 }
6433
6434 /* Else save so that we can tick off the recipient when the
6435 message is sent. */
6436
6437 else
6438 {
6439 *paddr = addr->next;
6440 addr->next = handled_addr;
6441 handled_addr = addr;
6442 }
6443 }
6444
6445 fprintf(f, "\n");
6446
6447 /* Get the next text, whether we need it or not, so as to be
6448 positioned for the one after. */
6449
6450 emf_text = next_emf(emf, US"generated text");
6451
6452 /* If there were any file messages passed by the local transports,
6453 include them in the message. Then put the address on the handled chain.
6454 In the case of a batch of addresses that were all sent to the same
6455 transport, the return_file field in all of them will contain the same
6456 fd, and the return_filename field in the *last* one will be set (to the
6457 name of the file). */
6458
6459 if (msgchain != NULL)
6460 {
6461 address_item *nextaddr;
6462
6463 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6464 fprintf(f,
6465 "The following text was generated during the delivery "
6466 "attempt%s:\n", (filecount > 1)? "s" : "");
6467
6468 for (addr = msgchain; addr != NULL; addr = nextaddr)
6469 {
6470 FILE *fm;
6471 address_item *topaddr = addr;
6472
6473 /* List all the addresses that relate to this file */
6474
6475 fprintf(f, "\n");
6476 while(addr != NULL) /* Insurance */
6477 {
6478 print_address_information(addr, f, US"------ ", US"\n ",
6479 US" ------\n");
6480 if (addr->return_filename != NULL) break;
6481 addr = addr->next;
6482 }
6483 fprintf(f, "\n");
6484
6485 /* Now copy the file */
6486
6487 fm = Ufopen(addr->return_filename, "rb");
6488
6489 if (fm == NULL)
6490 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6491 strerror(errno));
6492 else
6493 {
6494 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
f1e894f3 6495 (void)fclose(fm);
059ec3d9
PH
6496 }
6497 Uunlink(addr->return_filename);
6498
6499 /* Can now add to handled chain, first fishing off the next
6500 address on the msgchain. */
6501
6502 nextaddr = addr->next;
6503 addr->next = handled_addr;
6504 handled_addr = topaddr;
6505 }
6506 fprintf(f, "\n");
6507 }
6508
6509 /* Now copy the message, trying to give an intelligible comment if
6510 it is too long for it all to be copied. The limit isn't strictly
6511 applied because of the buffering. There is, however, an option
6512 to suppress copying altogether. */
6513
6514 emf_text = next_emf(emf, US"copy");
6515
6516 if (bounce_return_message)
6517 {
6518 int topt = topt_add_return_path;
6519 if (!bounce_return_body) topt |= topt_no_body;
6520
6521 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6522 {
6523 if (bounce_return_body) fprintf(f,
6524"------ This is a copy of the message, including all the headers. ------\n");
6525 else fprintf(f,
6526"------ This is a copy of the message's headers. ------\n");
6527 }
6528
6529 /* While reading the "truncated" message, set return_size_limit to
6530 the actual max testing value, rounded. We need to read the message
6531 whether we are going to use it or not. */
6532
6533 {
6534 int temp = bounce_return_size_limit;
6535 bounce_return_size_limit = (max/1000)*1000;
6536 emf_text = next_emf(emf, US"truncated");
6537 bounce_return_size_limit = temp;
6538 }
6539
6540 if (bounce_return_body && bounce_return_size_limit > 0)
6541 {
6542 struct stat statbuf;
6543 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6544 {
6545 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6546 {
6547 fprintf(f,
b1c749bb
PH
6548"------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
6549"------ %d or so are included here.\n", statbuf.st_size, max);
059ec3d9
PH
6550 }
6551 }
6552 }
6553
6554 fprintf(f, "\n");
6555 fflush(f);
6556 transport_filter_argv = NULL; /* Just in case */
6557 return_path = sender_address; /* In case not previously set */
6558 transport_write_message(NULL, fileno(f), topt,
6559 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6560 }
6561
6562 /* Write final text and close the template file if one is open */
6563
6564 if (emf != NULL)
6565 {
6566 emf_text = next_emf(emf, US"final");
6567 if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
f1e894f3 6568 (void)fclose(emf);
059ec3d9
PH
6569 }
6570
6571 /* Close the file, which should send an EOF to the child process
6572 that is receiving the message. Wait for it to finish. */
6573
f1e894f3 6574 (void)fclose(f);
059ec3d9
PH
6575 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6576
6577 /* In the test harness, let the child do it's thing first. */
6578
6579 if (running_in_test_harness) millisleep(500);
6580
6581 /* If the process failed, there was some disaster in setting up the
6582 error message. Unless the message is very old, ensure that addr_defer
6583 is non-null, which will have the effect of leaving the message on the
6584 spool. The failed addresses will get tried again next time. However, we
6585 don't really want this to happen too often, so freeze the message unless
6586 there are some genuine deferred addresses to try. To do this we have
6587 to call spool_write_header() here, because with no genuine deferred
6588 addresses the normal code below doesn't get run. */
6589
6590 if (rc != 0)
6591 {
6592 uschar *s = US"";
6593 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
6594 {
6595 addr_defer = (address_item *)(+1);
6596 deliver_freeze = TRUE;
6597 deliver_frozen_at = time(NULL);
6598 /* Panic-dies on error */
6599 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6600 s = US" (frozen)";
6601 }
6602 deliver_msglog("Process failed (%d) when writing error message "
6603 "to %s%s", rc, bounce_recipient, s);
6604 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6605 "to %s%s", rc, bounce_recipient, s);
6606 }
6607
6608 /* The message succeeded. Ensure that the recipients that failed are
6609 now marked finished with on the spool and their parents updated. */
6610
6611 else
6612 {
6613 for (addr = handled_addr; addr != NULL; addr = addr->next)
6614 {
6615 address_done(addr, logtod);
6616 child_done(addr, logtod);
6617 }
6618 /* Panic-dies on error */
6619 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6620 }
6621 }
6622 }
6623 }
6624
6625disable_logging = FALSE; /* In case left set */
6626
6627/* Come here from the mua_wrapper case if routing goes wrong */
6628
6629DELIVERY_TIDYUP:
6630
6631/* If there are now no deferred addresses, we are done. Preserve the
6632message log if so configured, and we are using them. Otherwise, sling it.
6633Then delete the message itself. */
6634
6635if (addr_defer == NULL)
6636 {
6637 if (message_logs)
6638 {
6639 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
6640 id);
6641 if (preserve_message_logs)
6642 {
6643 int rc;
6644 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
6645 if ((rc = Urename(spoolname, big_buffer)) < 0)
6646 {
6647 (void)directory_make(spool_directory, US"msglog.OLD",
6648 MSGLOG_DIRECTORY_MODE, TRUE);
6649 rc = Urename(spoolname, big_buffer);
6650 }
6651 if (rc < 0)
6652 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
6653 "msglog.OLD directory", spoolname);
6654 }
6655 else
6656 {
6657 if (Uunlink(spoolname) < 0)
0761d44e
TF
6658 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6659 spoolname, strerror(errno));
059ec3d9
PH
6660 }
6661 }
6662
6663 /* Remove the two message files. */
8e669ac1 6664
059ec3d9
PH
6665 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
6666 if (Uunlink(spoolname) < 0)
0ca0cf52
TF
6667 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6668 spoolname, strerror(errno));
059ec3d9
PH
6669 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
6670 if (Uunlink(spoolname) < 0)
0ca0cf52
TF
6671 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6672 spoolname, strerror(errno));
2ac0e484
PH
6673
6674 /* Log the end of this message, with queue time if requested. */
6675
6676 if ((log_extra_selector & LX_queue_time_overall) != 0)
8e669ac1 6677 log_write(0, LOG_MAIN, "Completed QT=%s",
2ac0e484
PH
6678 readconf_printtime(time(NULL) - received_time));
6679 else
6680 log_write(0, LOG_MAIN, "Completed");
0e8a9471
MH
6681
6682 /* Unset deliver_freeze so that we won't try to move the spool files further down */
6683 deliver_freeze = FALSE;
059ec3d9
PH
6684 }
6685
6686/* If there are deferred addresses, we are keeping this message because it is
6687not yet completed. Lose any temporary files that were catching output from
6688pipes for any of the deferred addresses, handle one-time aliases, and see if
6689the message has been on the queue for so long that it is time to send a warning
6690message to the sender, unless it is a mailer-daemon. If all deferred addresses
6691have the same domain, we can set deliver_domain for the expansion of
6692delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
6693the parent's domain.
6694
6695If all the deferred addresses have an error number that indicates "retry time
6696not reached", skip sending the warning message, because it won't contain the
6697reason for the delay. It will get sent at the next real delivery attempt.
6698However, if at least one address has tried, we'd better include all of them in
6699the message.
6700
6701If we can't make a process to send the message, don't worry.
6702
6703For mailing list expansions we want to send the warning message to the
6704mailing list manager. We can't do a perfect job here, as some addresses may
6705have different errors addresses, but if we take the errors address from
6706each deferred address it will probably be right in most cases.
6707
6708If addr_defer == +1, it means there was a problem sending an error message
6709for failed addresses, and there were no "real" deferred addresses. The value
6710was set just to keep the message on the spool, so there is nothing to do here.
6711*/
6712
6713else if (addr_defer != (address_item *)(+1))
6714 {
6715 address_item *addr;
6716 uschar *recipients = US"";
6717 BOOL delivery_attempted = FALSE;
6718
6719 deliver_domain = testflag(addr_defer, af_pfr)?
6720 addr_defer->parent->domain : addr_defer->domain;
6721
6722 for (addr = addr_defer; addr != NULL; addr = addr->next)
6723 {
6724 address_item *otaddr;
6725
6726 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
6727
6728 if (deliver_domain != NULL)
6729 {
6730 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
6731
6732 /* The domain may be unset for an address that has never been routed
6733 because the system filter froze the message. */
6734
6735 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
6736 }
6737
6738 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6739
6740 /* Handle the case of one-time aliases. If any address in the ancestry
6741 of this one is flagged, ensure it is in the recipients list, suitably
6742 flagged, and that its parent is marked delivered. */
6743
6744 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
6745 if (otaddr->onetime_parent != NULL) break;
6746
6747 if (otaddr != NULL)
6748 {
6749 int i;
6750 int t = recipients_count;
6751
6752 for (i = 0; i < recipients_count; i++)
6753 {
6754 uschar *r = recipients_list[i].address;
6755 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
6756 if (Ustrcmp(otaddr->address, r) == 0) break;
6757 }
6758
6759 /* Didn't find the address already in the list, and did find the
6760 ultimate parent's address in the list. After adding the recipient,
6761 update the errors address in the recipients list. */
6762
6763 if (i >= recipients_count && t < recipients_count)
6764 {
6765 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
6766 otaddr->address, otaddr->parent->address);
6767 receive_add_recipient(otaddr->address, t);
6768 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
6769 tree_add_nonrecipient(otaddr->parent->address);
6770 update_spool = TRUE;
6771 }
6772 }
6773
6774 /* Except for error messages, ensure that either the errors address for
6775 this deferred address or, if there is none, the sender address, is on the
6776 list of recipients for a warning message. */
6777
6778 if (sender_address[0] != 0)
6779 {
6780 if (addr->p.errors_address == NULL)
6781 {
6782 if (Ustrstr(recipients, sender_address) == NULL)
6783 recipients = string_sprintf("%s%s%s", recipients,
6784 (recipients[0] == 0)? "" : ",", sender_address);
6785 }
6786 else
6787 {
6788 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
6789 recipients = string_sprintf("%s%s%s", recipients,
6790 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
6791 }
6792 }
6793 }
6794
6795 /* Send a warning message if the conditions are right. If the condition check
6796 fails because of a lookup defer, there is nothing we can do. The warning
6797 is not sent. Another attempt will be made at the next delivery attempt (if
6798 it also defers). */
6799
6800 if (!queue_2stage && delivery_attempted &&
6801 delay_warning[1] > 0 && sender_address[0] != 0 &&
6802 (delay_warning_condition == NULL ||
6803 expand_check_condition(delay_warning_condition,
6804 US"delay_warning", US"option")))
6805 {
6806 int count;
6807 int show_time;
6808 int queue_time = time(NULL) - received_time;
6809
6810 /* When running in the test harness, there's an option that allows us to
6811 fudge this time so as to get repeatability of the tests. Take the first
6812 time off the list. In queue runs, the list pointer gets updated in the
6813 calling process. */
6814
6815 if (running_in_test_harness && fudged_queue_times[0] != 0)
6816 {
6817 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
6818 if (qt >= 0)
6819 {
6820 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
6821 fudged_queue_times);
6822 queue_time = qt;
6823 }
6824 }
6825
6826 /* See how many warnings we should have sent by now */
6827
6828 for (count = 0; count < delay_warning[1]; count++)
6829 if (queue_time < delay_warning[count+2]) break;
6830
6831 show_time = delay_warning[count+1];
6832
6833 if (count >= delay_warning[1])
6834 {
6835 int extra;
6836 int last_gap = show_time;
6837 if (count > 1) last_gap -= delay_warning[count];
6838 extra = (queue_time - delay_warning[count+1])/last_gap;
6839 show_time += last_gap * extra;
6840 count += extra;
6841 }
6842
6843 DEBUG(D_deliver)
6844 {
6845 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
6846 debug_printf("warning counts: required %d done %d\n", count,
6847 warning_count);
6848 }
6849
6850 /* We have computed the number of warnings there should have been by now.
6851 If there haven't been enough, send one, and up the count to what it should
6852 have been. */
6853
6854 if (warning_count < count)
6855 {
6856 header_line *h;
6857 int fd;
6858 pid_t pid = child_open_exim(&fd);
6859
6860 if (pid > 0)
6861 {
6862 uschar *wmf_text;
6863 FILE *wmf = NULL;
6864 FILE *f = fdopen(fd, "wb");
6865
6866 if (warn_message_file != NULL)
6867 {
6868 wmf = Ufopen(warn_message_file, "rb");
6869 if (wmf == NULL)
6870 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
6871 "message texts: %s", warn_message_file, strerror(errno));
6872 }
6873
6874 warnmsg_recipients = recipients;
6875 warnmsg_delay = (queue_time < 120*60)?
6876 string_sprintf("%d minutes", show_time/60):
6877 string_sprintf("%d hours", show_time/3600);
6878
6879 if (errors_reply_to != NULL)
6880 fprintf(f, "Reply-To: %s\n", errors_reply_to);
456682f5 6881 fprintf(f, "Auto-Submitted: auto-replied\n");
0e22dfd1 6882 moan_write_from(f);
059ec3d9
PH
6883 fprintf(f, "To: %s\n", recipients);
6884
6885 wmf_text = next_emf(wmf, US"header");
6886 if (wmf_text != NULL)
6887 fprintf(f, "%s\n", wmf_text);
6888 else
6889 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6890 message_id, warnmsg_delay);
6891
6892 wmf_text = next_emf(wmf, US"intro");
6893 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
6894 {
6895 fprintf(f,
6896"This message was created automatically by mail delivery software.\n");
6897
6898 if (Ustrcmp(recipients, sender_address) == 0)
6899 fprintf(f,
6900"A message that you sent has not yet been delivered to one or more of its\n"
6901"recipients after more than ");
6902
6903 else fprintf(f,
6904"A message sent by\n\n <%s>\n\n"
6905"has not yet been delivered to one or more of its recipients after more than \n",
6906 sender_address);
6907
6908 fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
6909 primary_hostname);
6910 fprintf(f, "The message identifier is: %s\n", message_id);
6911
6912 for (h = header_list; h != NULL; h = h->next)
6913 {
6914 if (strncmpic(h->text, US"Subject:", 8) == 0)
6915 fprintf(f, "The subject of the message is: %s", h->text + 9);
6916 else if (strncmpic(h->text, US"Date:", 5) == 0)
6917 fprintf(f, "The date of the message is: %s", h->text + 6);
6918 }
6919 fprintf(f, "\n");
6920
6921 fprintf(f, "The address%s to which the message has not yet been "
6922 "delivered %s:\n",
6923 (addr_defer->next == NULL)? "" : "es",
6924 (addr_defer->next == NULL)? "is": "are");
6925 }
6926
447d236c 6927 /* List the addresses, with error information if allowed */
059ec3d9
PH
6928
6929 fprintf(f, "\n");
6930 while (addr_defer != NULL)
6931 {
6932 address_item *addr = addr_defer;
6933 addr_defer = addr->next;
447d236c
PH
6934 if (print_address_information(addr, f, US" ", US"\n ", US""))
6935 print_address_error(addr, f, US"Delay reason: ");
059ec3d9
PH
6936 fprintf(f, "\n");
6937 }
6938 fprintf(f, "\n");
6939
6940 /* Final text */
6941
6942 if (wmf != NULL)
6943 {
6944 wmf_text = next_emf(wmf, US"final");
6945 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
f1e894f3 6946 (void)fclose(wmf);
059ec3d9
PH
6947 }
6948 else
6949 {
6950 fprintf(f,
6951"No action is required on your part. Delivery attempts will continue for\n"
6952"some time, and this warning may be repeated at intervals if the message\n"
6953"remains undelivered. Eventually the mail delivery software will give up,\n"
6954"and when that happens, the message will be returned to you.\n");
6955 }
6956
6957 /* Close and wait for child process to complete, without a timeout.
6958 If there's an error, don't update the count. */
6959
f1e894f3 6960 (void)fclose(f);
059ec3d9
PH
6961 if (child_close(pid, 0) == 0)
6962 {
6963 warning_count = count;
6964 update_spool = TRUE; /* Ensure spool rewritten */
6965 }
6966 }
6967 }
6968 }
6969
6970 /* Clear deliver_domain */
6971
6972 deliver_domain = NULL;
6973
6974 /* If this was a first delivery attempt, unset the first time flag, and
6975 ensure that the spool gets updated. */
6976
6977 if (deliver_firsttime)
6978 {
6979 deliver_firsttime = FALSE;
6980 update_spool = TRUE;
6981 }
6982
6983 /* If delivery was frozen and freeze_tell is set, generate an appropriate
6984 message, unless the message is a local error message (to avoid loops). Then
6985 log the freezing. If the text in "frozen_info" came from a system filter,
6986 it has been escaped into printing characters so as not to mess up log lines.
6987 For the "tell" message, we turn \n back into newline. Also, insert a newline
6988 near the start instead of the ": " string. */
6989
6990 if (deliver_freeze)
6991 {
6992 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
6993 {
6994 uschar *s = string_copy(frozen_info);
6995 uschar *ss = Ustrstr(s, " by the system filter: ");
6996
6997 if (ss != NULL)
6998 {
6999 ss[21] = '.';
7000 ss[22] = '\n';
7001 }
7002
7003 ss = s;
7004 while (*ss != 0)
7005 {
7006 if (*ss == '\\' && ss[1] == 'n')
7007 {
7008 *ss++ = ' ';
7009 *ss++ = '\n';
7010 }
7011 else ss++;
7012 }
7013 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7014 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7015 s, sender_address);
7016 }
7017
7018 /* Log freezing just before we update the -H file, to minimize the chance
7019 of a race problem. */
7020
7021 deliver_msglog("*** Frozen%s\n", frozen_info);
7022 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7023 }
7024
7025 /* If there have been any updates to the non-recipients list, or other things
7026 that get written to the spool, we must now update the spool header file so
7027 that it has the right information for the next delivery attempt. If there
7028 was more than one address being delivered, the header_change update is done
7029 earlier, in case one succeeds and then something crashes. */
7030
7031 DEBUG(D_deliver)
7032 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7033 update_spool, header_rewritten);
7034
7035 if (update_spool || header_rewritten)
7036 /* Panic-dies on error */
7037 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7038 }
7039
7040/* Finished with the message log. If the message is complete, it will have
7041been unlinked or renamed above. */
7042
f1e894f3 7043if (message_logs) (void)fclose(message_log);
059ec3d9
PH
7044
7045/* Now we can close and remove the journal file. Its only purpose is to record
7046successfully completed deliveries asap so that this information doesn't get
7047lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7048not serious, as trying it again is not harmful. The journal might not be open
7049if all addresses were deferred at routing or directing. Nevertheless, we must
7050remove it if it exists (may have been lying around from a crash during the
7051previous delivery attempt). We don't remove the journal if a delivery
7052subprocess failed to pass back delivery information; this is controlled by
7053the remove_journal flag. When the journal is left, we also don't move the
7054message off the main spool if frozen and the option is set. It should get moved
7055at the next attempt, after the journal has been inspected. */
7056
f1e894f3 7057if (journal_fd >= 0) (void)close(journal_fd);
059ec3d9
PH
7058
7059if (remove_journal)
7060 {
7061 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7062 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7063 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7064 strerror(errno));
7065
7066 /* Move the message off the spool if reqested */
7067
7068 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7069 if (deliver_freeze && move_frozen_messages)
7070 (void)spool_move_message(id, message_subdir, US"", US"F");
7071 #endif
7072 }
7073
7074/* Closing the data file frees the lock; if the file has been unlinked it
7075will go away. Otherwise the message becomes available for another process
7076to try delivery. */
7077
f1e894f3 7078(void)close(deliver_datafile);
059ec3d9
PH
7079deliver_datafile = -1;
7080DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7081
7082/* It is unlikely that there will be any cached resources, since they are
7083released after routing, and in the delivery subprocesses. However, it's
7084possible for an expansion for something afterwards (for example,
7085expand_check_condition) to do a lookup. We must therefore be sure everything is
7086released. */
7087
7088search_tidyup();
faa05a93 7089acl_where = ACL_WHERE_UNKNOWN;
059ec3d9
PH
7090return final_yield;
7091}
7092
7093/* End of deliver.c */