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