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