c01e4e61b7123f5b4464e0b607f770310026a8d8
[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 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
677 this is a nonstandard call; no two-characher delivery flag is written
678 but sender-host and sender are prefixed and "msg" is inserted in the log line.
679
680 Arguments:
681 flags passed to log_write()
682 */
683 void
684 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
685 {
686 uschar *log_address;
687 int size = 256; /* Used for a temporary, */
688 int ptr = 0; /* expanding buffer, for */
689 uschar *s; /* building log lines; */
690 void *reset_point; /* released afterwards. */
691
692
693 /* Log the delivery on the main log. We use an extensible string to build up
694 the log line, and reset the store afterwards. Remote deliveries should always
695 have a pointer to the host item that succeeded; local deliveries can have a
696 pointer to a single host item in their host list, for use by the transport. */
697
698 s = reset_point = store_get(size);
699
700 log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
701 if (msg)
702 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
703 else
704 {
705 s[ptr++] = logchar;
706 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
707 }
708
709 if ((log_extra_selector & LX_sender_on_delivery) != 0 || msg)
710 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
711
712 #ifdef EXPERIMENTAL_SRS
713 if(addr->p.srs_sender)
714 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
715 #endif
716
717 /* You might think that the return path must always be set for a successful
718 delivery; indeed, I did for some time, until this statement crashed. The case
719 when it is not set is for a delivery to /dev/null which is optimised by not
720 being run at all. */
721
722 if (used_return_path != NULL &&
723 (log_extra_selector & LX_return_path_on_delivery) != 0)
724 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
725
726 if (msg)
727 s = string_append(s, &size, &ptr, 2, US" ", msg);
728
729 /* For a delivery from a system filter, there may not be a router */
730 if (addr->router != NULL)
731 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
732
733 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
734
735 if ((log_extra_selector & LX_delivery_size) != 0)
736 s = string_append(s, &size, &ptr, 2, US" S=",
737 string_sprintf("%d", transport_count));
738
739 /* Local delivery */
740
741 if (addr->transport->info->local)
742 {
743 if (addr->host_list != NULL)
744 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
745 if (addr->shadow_message != NULL)
746 s = string_cat(s, &size, &ptr, addr->shadow_message,
747 Ustrlen(addr->shadow_message));
748 }
749
750 /* Remote delivery */
751
752 else
753 {
754 if (addr->host_used != NULL)
755 {
756 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
757 US" [", addr->host_used->address, US"]");
758 if ((log_extra_selector & LX_outgoing_port) != 0)
759 s = string_append(s, &size, &ptr, 2, US":", string_sprintf("%d",
760 addr->host_used->port));
761 if (continue_sequence > 1)
762 s = string_cat(s, &size, &ptr, US"*", 1);
763 }
764
765 #ifdef SUPPORT_TLS
766 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
767 s = string_append(s, &size, &ptr, 2, US" X=", addr->cipher);
768 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
769 addr->cipher != NULL)
770 s = string_append(s, &size, &ptr, 2, US" CV=",
771 testflag(addr, af_cert_verified)? "yes":"no");
772 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
773 s = string_append(s, &size, &ptr, 3, US" DN=\"",
774 string_printing(addr->peerdn), US"\"");
775 #endif
776
777 if (smtp_authenticated)
778 {
779 s = string_append(s, &size, &ptr, 2, US" A=", client_authenticator);
780 if (client_authenticated_id)
781 s = string_append(s, &size, &ptr, 2, US":", client_authenticated_id);
782 }
783
784 if ((log_extra_selector & LX_smtp_confirmation) != 0 &&
785 addr->message != NULL)
786 {
787 int i;
788 uschar *p = big_buffer;
789 uschar *ss = addr->message;
790 *p++ = '\"';
791 for (i = 0; i < 100 && ss[i] != 0; i++)
792 {
793 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\';
794 *p++ = ss[i];
795 }
796 *p++ = '\"';
797 *p = 0;
798 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
799 }
800 }
801
802 /* Time on queue and actual time taken to deliver */
803
804 if ((log_extra_selector & LX_queue_time) != 0)
805 {
806 s = string_append(s, &size, &ptr, 2, US" QT=",
807 readconf_printtime(time(NULL) - received_time));
808 }
809
810 if ((log_extra_selector & LX_deliver_time) != 0)
811 {
812 s = string_append(s, &size, &ptr, 2, US" DT=",
813 readconf_printtime(addr->more_errno));
814 }
815
816 /* string_cat() always leaves room for the terminator. Release the
817 store we used to build the line after writing it. */
818
819 s[ptr] = 0;
820 log_write(0, flags, "%s", s);
821 store_reset(reset_point);
822 return;
823 }
824
825
826
827 /*************************************************
828 * Actions at the end of handling an address *
829 *************************************************/
830
831 /* This is a function for processing a single address when all that can be done
832 with it has been done.
833
834 Arguments:
835 addr points to the address block
836 result the result of the delivery attempt
837 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
838 driver_type indicates which type of driver (transport, or router) was last
839 to process the address
840 logchar '=' or '-' for use when logging deliveries with => or ->
841
842 Returns: nothing
843 */
844
845 static void
846 post_process_one(address_item *addr, int result, int logflags, int driver_type,
847 int logchar)
848 {
849 uschar *now = tod_stamp(tod_log);
850 uschar *driver_kind = NULL;
851 uschar *driver_name = NULL;
852 uschar *log_address;
853
854 int size = 256; /* Used for a temporary, */
855 int ptr = 0; /* expanding buffer, for */
856 uschar *s; /* building log lines; */
857 void *reset_point; /* released afterwards. */
858
859
860 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
861
862 /* Set up driver kind and name for logging. Disable logging if the router or
863 transport has disabled it. */
864
865 if (driver_type == DTYPE_TRANSPORT)
866 {
867 if (addr->transport != NULL)
868 {
869 driver_name = addr->transport->name;
870 driver_kind = US" transport";
871 disable_logging = addr->transport->disable_logging;
872 }
873 else driver_kind = US"transporting";
874 }
875 else if (driver_type == DTYPE_ROUTER)
876 {
877 if (addr->router != NULL)
878 {
879 driver_name = addr->router->name;
880 driver_kind = US" router";
881 disable_logging = addr->router->disable_logging;
882 }
883 else driver_kind = US"routing";
884 }
885
886 /* If there's an error message set, ensure that it contains only printing
887 characters - it should, but occasionally things slip in and this at least
888 stops the log format from getting wrecked. We also scan the message for an LDAP
889 expansion item that has a password setting, and flatten the password. This is a
890 fudge, but I don't know a cleaner way of doing this. (If the item is badly
891 malformed, it won't ever have gone near LDAP.) */
892
893 if (addr->message != NULL)
894 {
895 addr->message = string_printing(addr->message);
896 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
897 (Ustrstr(addr->message, "mysql") != NULL ||
898 Ustrstr(addr->message, "pgsql") != NULL ||
899 Ustrstr(addr->message, "sqlite") != NULL ||
900 Ustrstr(addr->message, "ldap:") != NULL ||
901 Ustrstr(addr->message, "ldapdn:") != NULL ||
902 Ustrstr(addr->message, "ldapm:") != NULL))
903 {
904 addr->message = string_sprintf("Temporary internal error");
905 }
906 }
907
908 /* If we used a transport that has one of the "return_output" options set, and
909 if it did in fact generate some output, then for return_output we treat the
910 message as failed if it was not already set that way, so that the output gets
911 returned to the sender, provided there is a sender to send it to. For
912 return_fail_output, do this only if the delivery failed. Otherwise we just
913 unlink the file, and remove the name so that if the delivery failed, we don't
914 try to send back an empty or unwanted file. The log_output options operate only
915 on a non-empty file.
916
917 In any case, we close the message file, because we cannot afford to leave a
918 file-descriptor for one address while processing (maybe very many) others. */
919
920 if (addr->return_file >= 0 && addr->return_filename != NULL)
921 {
922 BOOL return_output = FALSE;
923 struct stat statbuf;
924 (void)EXIMfsync(addr->return_file);
925
926 /* If there is no output, do nothing. */
927
928 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
929 {
930 transport_instance *tb = addr->transport;
931
932 /* Handle logging options */
933
934 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
935 (result == DEFER && tb->log_defer_output))
936 {
937 uschar *s;
938 FILE *f = Ufopen(addr->return_filename, "rb");
939 if (f == NULL)
940 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
941 "from %s transport: %s", addr->return_filename, tb->name,
942 strerror(errno));
943 else
944 {
945 s = US Ufgets(big_buffer, big_buffer_size, f);
946 if (s != NULL)
947 {
948 uschar *p = big_buffer + Ustrlen(big_buffer);
949 while (p > big_buffer && isspace(p[-1])) p--;
950 *p = 0;
951 s = string_printing(big_buffer);
952 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
953 addr->address, tb->name, s);
954 }
955 (void)fclose(f);
956 }
957 }
958
959 /* Handle returning options, but only if there is an address to return
960 the text to. */
961
962 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
963 {
964 if (tb->return_output)
965 {
966 addr->transport_return = result = FAIL;
967 if (addr->basic_errno == 0 && addr->message == NULL)
968 addr->message = US"return message generated";
969 return_output = TRUE;
970 }
971 else
972 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
973 }
974 }
975
976 /* Get rid of the file unless it might be returned, but close it in
977 all cases. */
978
979 if (!return_output)
980 {
981 Uunlink(addr->return_filename);
982 addr->return_filename = NULL;
983 addr->return_file = -1;
984 }
985
986 (void)close(addr->return_file);
987 }
988
989 /* The sucess case happens only after delivery by a transport. */
990
991 if (result == OK)
992 {
993 addr->next = addr_succeed;
994 addr_succeed = addr;
995
996 /* Call address_done() to ensure that we don't deliver to this address again,
997 and write appropriate things to the message log. If it is a child address, we
998 call child_done() to scan the ancestors and mark them complete if this is the
999 last child to complete. */
1000
1001 address_done(addr, now);
1002 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1003
1004 if (addr->parent == NULL)
1005 {
1006 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1007 driver_name, driver_kind);
1008 }
1009 else
1010 {
1011 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1012 addr->parent->address, driver_name, driver_kind);
1013 child_done(addr, now);
1014 }
1015
1016 delivery_log(LOG_MAIN, addr, logchar, NULL);
1017 }
1018
1019
1020 /* Soft failure, or local delivery process failed; freezing may be
1021 requested. */
1022
1023 else if (result == DEFER || result == PANIC)
1024 {
1025 if (result == PANIC) logflags |= LOG_PANIC;
1026
1027 /* This puts them on the chain in reverse order. Do not change this, because
1028 the code for handling retries assumes that the one with the retry
1029 information is last. */
1030
1031 addr->next = addr_defer;
1032 addr_defer = addr;
1033
1034 /* The only currently implemented special action is to freeze the
1035 message. Logging of this is done later, just before the -H file is
1036 updated. */
1037
1038 if (addr->special_action == SPECIAL_FREEZE)
1039 {
1040 deliver_freeze = TRUE;
1041 deliver_frozen_at = time(NULL);
1042 update_spool = TRUE;
1043 }
1044
1045 /* If doing a 2-stage queue run, we skip writing to either the message
1046 log or the main log for SMTP defers. */
1047
1048 if (!queue_2stage || addr->basic_errno != 0)
1049 {
1050 uschar ss[32];
1051
1052 /* For errors of the type "retry time not reached" (also remotes skipped
1053 on queue run), logging is controlled by L_retry_defer. Note that this kind
1054 of error number is negative, and all the retry ones are less than any
1055 others. */
1056
1057 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1058 L_retry_defer : 0;
1059
1060 /* Build up the line that is used for both the message log and the main
1061 log. */
1062
1063 s = reset_point = store_get(size);
1064
1065 /* Create the address string for logging. Must not do this earlier, because
1066 an OK result may be changed to FAIL when a pipe returns text. */
1067
1068 log_address = string_log_address(addr,
1069 (log_write_selector & L_all_parents) != 0, result == OK);
1070
1071 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1072
1073 /* Either driver_name contains something and driver_kind contains
1074 " router" or " transport" (note the leading space), or driver_name is
1075 a null string and driver_kind contains "routing" without the leading
1076 space, if all routing has been deferred. When a domain has been held,
1077 so nothing has been done at all, both variables contain null strings. */
1078
1079 if (driver_name == NULL)
1080 {
1081 if (driver_kind != NULL)
1082 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1083 }
1084 else
1085 {
1086 if (driver_kind[1] == 't' && addr->router != NULL)
1087 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1088 Ustrcpy(ss, " ?=");
1089 ss[1] = toupper(driver_kind[1]);
1090 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1091 }
1092
1093 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1094 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1095
1096 if (addr->basic_errno > 0)
1097 s = string_append(s, &size, &ptr, 2, US": ",
1098 US strerror(addr->basic_errno));
1099
1100 if (addr->message != NULL)
1101 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1102
1103 s[ptr] = 0;
1104
1105 /* Log the deferment in the message log, but don't clutter it
1106 up with retry-time defers after the first delivery attempt. */
1107
1108 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1109 deliver_msglog("%s %s\n", now, s);
1110
1111 /* Write the main log and reset the store */
1112
1113 log_write(use_log_selector, logflags, "== %s", s);
1114 store_reset(reset_point);
1115 }
1116 }
1117
1118
1119 /* Hard failure. If there is an address to which an error message can be sent,
1120 put this address on the failed list. If not, put it on the deferred list and
1121 freeze the mail message for human attention. The latter action can also be
1122 explicitly requested by a router or transport. */
1123
1124 else
1125 {
1126 /* If this is a delivery error, or a message for which no replies are
1127 wanted, and the message's age is greater than ignore_bounce_errors_after,
1128 force the af_ignore_error flag. This will cause the address to be discarded
1129 later (with a log entry). */
1130
1131 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1132 setflag(addr, af_ignore_error);
1133
1134 /* Freeze the message if requested, or if this is a bounce message (or other
1135 message with null sender) and this address does not have its own errors
1136 address. However, don't freeze if errors are being ignored. The actual code
1137 to ignore occurs later, instead of sending a message. Logging of freezing
1138 occurs later, just before writing the -H file. */
1139
1140 if (!testflag(addr, af_ignore_error) &&
1141 (addr->special_action == SPECIAL_FREEZE ||
1142 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1143 ))
1144 {
1145 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1146 (sender_local && !local_error_message)?
1147 US" (message created with -f <>)" : US" (delivery error message)";
1148 deliver_freeze = TRUE;
1149 deliver_frozen_at = time(NULL);
1150 update_spool = TRUE;
1151
1152 /* The address is put on the defer rather than the failed queue, because
1153 the message is being retained. */
1154
1155 addr->next = addr_defer;
1156 addr_defer = addr;
1157 }
1158
1159 /* Don't put the address on the nonrecipients tree yet; wait until an
1160 error message has been successfully sent. */
1161
1162 else
1163 {
1164 addr->next = addr_failed;
1165 addr_failed = addr;
1166 }
1167
1168 /* Build up the log line for the message and main logs */
1169
1170 s = reset_point = store_get(size);
1171
1172 /* Create the address string for logging. Must not do this earlier, because
1173 an OK result may be changed to FAIL when a pipe returns text. */
1174
1175 log_address = string_log_address(addr,
1176 (log_write_selector & L_all_parents) != 0, result == OK);
1177
1178 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1179
1180 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1181 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1182
1183 /* Return path may not be set if no delivery actually happened */
1184
1185 if (used_return_path != NULL &&
1186 (log_extra_selector & LX_return_path_on_delivery) != 0)
1187 {
1188 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1189 }
1190
1191 if (addr->router != NULL)
1192 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1193 if (addr->transport != NULL)
1194 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1195
1196 if (addr->host_used != NULL)
1197 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
1198 US" [", addr->host_used->address, US"]");
1199
1200 if (addr->basic_errno > 0)
1201 s = string_append(s, &size, &ptr, 2, US": ",
1202 US strerror(addr->basic_errno));
1203
1204 if (addr->message != NULL)
1205 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1206
1207 s[ptr] = 0;
1208
1209 /* Do the logging. For the message log, "routing failed" for those cases,
1210 just to make it clearer. */
1211
1212 if (driver_name == NULL)
1213 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1214 else
1215 deliver_msglog("%s %s\n", now, s);
1216
1217 log_write(0, LOG_MAIN, "** %s", s);
1218 store_reset(reset_point);
1219 }
1220
1221 /* Ensure logging is turned on again in all cases */
1222
1223 disable_logging = FALSE;
1224 }
1225
1226
1227
1228
1229 /*************************************************
1230 * Address-independent error *
1231 *************************************************/
1232
1233 /* This function is called when there's an error that is not dependent on a
1234 particular address, such as an expansion string failure. It puts the error into
1235 all the addresses in a batch, logs the incident on the main and panic logs, and
1236 clears the expansions. It is mostly called from local_deliver(), but can be
1237 called for a remote delivery via findugid().
1238
1239 Arguments:
1240 logit TRUE if (MAIN+PANIC) logging required
1241 addr the first of the chain of addresses
1242 code the error code
1243 format format string for error message, or NULL if already set in addr
1244 ... arguments for the format
1245
1246 Returns: nothing
1247 */
1248
1249 static void
1250 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1251 {
1252 address_item *addr2;
1253 addr->basic_errno = code;
1254
1255 if (format != NULL)
1256 {
1257 va_list ap;
1258 uschar buffer[512];
1259 va_start(ap, format);
1260 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1261 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1262 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1263 va_end(ap);
1264 addr->message = string_copy(buffer);
1265 }
1266
1267 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1268 {
1269 addr2->basic_errno = code;
1270 addr2->message = addr->message;
1271 }
1272
1273 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1274 deliver_set_expansions(NULL);
1275 }
1276
1277
1278
1279
1280 /*************************************************
1281 * Check a "never users" list *
1282 *************************************************/
1283
1284 /* This function is called to check whether a uid is on one of the two "never
1285 users" lists.
1286
1287 Arguments:
1288 uid the uid to be checked
1289 nusers the list to be scanned; the first item in the list is the count
1290
1291 Returns: TRUE if the uid is on the list
1292 */
1293
1294 static BOOL
1295 check_never_users(uid_t uid, uid_t *nusers)
1296 {
1297 int i;
1298 if (nusers == NULL) return FALSE;
1299 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1300 return FALSE;
1301 }
1302
1303
1304
1305 /*************************************************
1306 * Find uid and gid for a transport *
1307 *************************************************/
1308
1309 /* This function is called for both local and remote deliveries, to find the
1310 uid/gid under which to run the delivery. The values are taken preferentially
1311 from the transport (either explicit or deliver_as_creator), then from the
1312 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1313 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1314 panic error is logged, and the function fails (which normally leads to delivery
1315 deferral).
1316
1317 Arguments:
1318 addr the address (possibly a chain)
1319 tp the transport
1320 uidp pointer to uid field
1321 gidp pointer to gid field
1322 igfp pointer to the use_initgroups field
1323
1324 Returns: FALSE if failed - error has been set in address(es)
1325 */
1326
1327 static BOOL
1328 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1329 BOOL *igfp)
1330 {
1331 uschar *nuname = NULL;
1332 BOOL gid_set = FALSE;
1333
1334 /* Default initgroups flag comes from the transport */
1335
1336 *igfp = tp->initgroups;
1337
1338 /* First see if there's a gid on the transport, either fixed or expandable.
1339 The expanding function always logs failure itself. */
1340
1341 if (tp->gid_set)
1342 {
1343 *gidp = tp->gid;
1344 gid_set = TRUE;
1345 }
1346 else if (tp->expand_gid != NULL)
1347 {
1348 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1349 &(addr->message))) gid_set = TRUE;
1350 else
1351 {
1352 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1353 return FALSE;
1354 }
1355 }
1356
1357 /* If the transport did not set a group, see if the router did. */
1358
1359 if (!gid_set && testflag(addr, af_gid_set))
1360 {
1361 *gidp = addr->gid;
1362 gid_set = TRUE;
1363 }
1364
1365 /* Pick up a uid from the transport if one is set. */
1366
1367 if (tp->uid_set) *uidp = tp->uid;
1368
1369 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1370 it does not provide a passwd value from which a gid can be taken. */
1371
1372 else if (tp->expand_uid != NULL)
1373 {
1374 struct passwd *pw;
1375 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1376 uidp, &(addr->message)))
1377 {
1378 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1379 return FALSE;
1380 }
1381 if (!gid_set && pw != NULL)
1382 {
1383 *gidp = pw->pw_gid;
1384 gid_set = TRUE;
1385 }
1386 }
1387
1388 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1389
1390 else if (tp->deliver_as_creator)
1391 {
1392 *uidp = originator_uid;
1393 if (!gid_set)
1394 {
1395 *gidp = originator_gid;
1396 gid_set = TRUE;
1397 }
1398 }
1399
1400 /* Otherwise see if the address specifies the uid and if so, take it and its
1401 initgroups flag. */
1402
1403 else if (testflag(addr, af_uid_set))
1404 {
1405 *uidp = addr->uid;
1406 *igfp = testflag(addr, af_initgroups);
1407 }
1408
1409 /* Nothing has specified the uid - default to the Exim user, and group if the
1410 gid is not set. */
1411
1412 else
1413 {
1414 *uidp = exim_uid;
1415 if (!gid_set)
1416 {
1417 *gidp = exim_gid;
1418 gid_set = TRUE;
1419 }
1420 }
1421
1422 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1423 defaulting to the Exim uid. In other words, if the configuration has specified
1424 a uid, it must also provide a gid. */
1425
1426 if (!gid_set)
1427 {
1428 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1429 "%s transport", tp->name);
1430 return FALSE;
1431 }
1432
1433 /* Check that the uid is not on the lists of banned uids that may not be used
1434 for delivery processes. */
1435
1436 if (check_never_users(*uidp, never_users))
1437 nuname = US"never_users";
1438 else if (check_never_users(*uidp, fixed_never_users))
1439 nuname = US"fixed_never_users";
1440
1441 if (nuname != NULL)
1442 {
1443 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1444 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1445 return FALSE;
1446 }
1447
1448 /* All is well */
1449
1450 return TRUE;
1451 }
1452
1453
1454
1455
1456 /*************************************************
1457 * Check the size of a message for a transport *
1458 *************************************************/
1459
1460 /* Checks that the message isn't too big for the selected transport.
1461 This is called only when it is known that the limit is set.
1462
1463 Arguments:
1464 tp the transport
1465 addr the (first) address being delivered
1466
1467 Returns: OK
1468 DEFER expansion failed or did not yield an integer
1469 FAIL message too big
1470 */
1471
1472 int
1473 check_message_size(transport_instance *tp, address_item *addr)
1474 {
1475 int rc = OK;
1476 int size_limit;
1477
1478 deliver_set_expansions(addr);
1479 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1480 deliver_set_expansions(NULL);
1481
1482 if (expand_string_message != NULL)
1483 {
1484 rc = DEFER;
1485 if (size_limit == -1)
1486 addr->message = string_sprintf("failed to expand message_size_limit "
1487 "in %s transport: %s", tp->name, expand_string_message);
1488 else
1489 addr->message = string_sprintf("invalid message_size_limit "
1490 "in %s transport: %s", tp->name, expand_string_message);
1491 }
1492 else if (size_limit > 0 && message_size > size_limit)
1493 {
1494 rc = FAIL;
1495 addr->message =
1496 string_sprintf("message is too big (transport limit = %d)",
1497 size_limit);
1498 }
1499
1500 return rc;
1501 }
1502
1503
1504
1505 /*************************************************
1506 * Transport-time check for a previous delivery *
1507 *************************************************/
1508
1509 /* Check that this base address hasn't previously been delivered to its routed
1510 transport. If it has been delivered, mark it done. The check is necessary at
1511 delivery time in order to handle homonymic addresses correctly in cases where
1512 the pattern of redirection changes between delivery attempts (so the unique
1513 fields change). Non-homonymic previous delivery is detected earlier, at routing
1514 time (which saves unnecessary routing).
1515
1516 Arguments:
1517 addr the address item
1518 testing TRUE if testing wanted only, without side effects
1519
1520 Returns: TRUE if previously delivered by the transport
1521 */
1522
1523 static BOOL
1524 previously_transported(address_item *addr, BOOL testing)
1525 {
1526 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1527 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1528
1529 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1530 {
1531 DEBUG(D_deliver|D_route|D_transport)
1532 debug_printf("%s was previously delivered (%s transport): discarded\n",
1533 addr->address, addr->transport->name);
1534 if (!testing) child_done(addr, tod_stamp(tod_log));
1535 return TRUE;
1536 }
1537
1538 return FALSE;
1539 }
1540
1541
1542
1543 /******************************************************
1544 * Check for a given header in a header string *
1545 ******************************************************/
1546
1547 /* This function is used when generating quota warnings. The configuration may
1548 specify any header lines it likes in quota_warn_message. If certain of them are
1549 missing, defaults are inserted, so we need to be able to test for the presence
1550 of a given header.
1551
1552 Arguments:
1553 hdr the required header name
1554 hstring the header string
1555
1556 Returns: TRUE the header is in the string
1557 FALSE the header is not in the string
1558 */
1559
1560 static BOOL
1561 contains_header(uschar *hdr, uschar *hstring)
1562 {
1563 int len = Ustrlen(hdr);
1564 uschar *p = hstring;
1565 while (*p != 0)
1566 {
1567 if (strncmpic(p, hdr, len) == 0)
1568 {
1569 p += len;
1570 while (*p == ' ' || *p == '\t') p++;
1571 if (*p == ':') return TRUE;
1572 }
1573 while (*p != 0 && *p != '\n') p++;
1574 if (*p == '\n') p++;
1575 }
1576 return FALSE;
1577 }
1578
1579
1580
1581
1582 /*************************************************
1583 * Perform a local delivery *
1584 *************************************************/
1585
1586 /* Each local delivery is performed in a separate process which sets its
1587 uid and gid as specified. This is a safer way than simply changing and
1588 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1589 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1590 all systems have seteuid().
1591
1592 If the uid/gid are specified in the transport_instance, they are used; the
1593 transport initialization must ensure that either both or neither are set.
1594 Otherwise, the values associated with the address are used. If neither are set,
1595 it is a configuration error.
1596
1597 The transport or the address may specify a home directory (transport over-
1598 rides), and if they do, this is set as $home. If neither have set a working
1599 directory, this value is used for that as well. Otherwise $home is left unset
1600 and the cwd is set to "/" - a directory that should be accessible to all users.
1601
1602 Using a separate process makes it more complicated to get error information
1603 back. We use a pipe to pass the return code and also an error code and error
1604 text string back to the parent process.
1605
1606 Arguments:
1607 addr points to an address block for this delivery; for "normal" local
1608 deliveries this is the only address to be delivered, but for
1609 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1610 a number of addresses can be handled simultaneously, and in this
1611 case addr will point to a chain of addresses with the same
1612 characteristics.
1613
1614 shadowing TRUE if running a shadow transport; this causes output from pipes
1615 to be ignored.
1616
1617 Returns: nothing
1618 */
1619
1620 static void
1621 deliver_local(address_item *addr, BOOL shadowing)
1622 {
1623 BOOL use_initgroups;
1624 uid_t uid;
1625 gid_t gid;
1626 int status, len, rc;
1627 int pfd[2];
1628 pid_t pid;
1629 uschar *working_directory;
1630 address_item *addr2;
1631 transport_instance *tp = addr->transport;
1632
1633 /* Set up the return path from the errors or sender address. If the transport
1634 has its own return path setting, expand it and replace the existing value. */
1635
1636 if(addr->p.errors_address != NULL)
1637 return_path = addr->p.errors_address;
1638 #ifdef EXPERIMENTAL_SRS
1639 else if(addr->p.srs_sender != NULL)
1640 return_path = addr->p.srs_sender;
1641 #endif
1642 else
1643 return_path = sender_address;
1644
1645 if (tp->return_path != NULL)
1646 {
1647 uschar *new_return_path = expand_string(tp->return_path);
1648 if (new_return_path == NULL)
1649 {
1650 if (!expand_string_forcedfail)
1651 {
1652 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1653 US"Failed to expand return path \"%s\" in %s transport: %s",
1654 tp->return_path, tp->name, expand_string_message);
1655 return;
1656 }
1657 }
1658 else return_path = new_return_path;
1659 }
1660
1661 /* For local deliveries, one at a time, the value used for logging can just be
1662 set directly, once and for all. */
1663
1664 used_return_path = return_path;
1665
1666 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1667 gets put into the address(es), and the expansions are unset, so we can just
1668 return. */
1669
1670 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1671
1672 /* See if either the transport or the address specifies a home directory. A
1673 home directory set in the address may already be expanded; a flag is set to
1674 indicate that. In other cases we must expand it. */
1675
1676 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1677 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1678 !testflag(addr, af_home_expanded))) /* not expanded */
1679 {
1680 uschar *rawhome = deliver_home;
1681 deliver_home = NULL; /* in case it contains $home */
1682 deliver_home = expand_string(rawhome);
1683 if (deliver_home == NULL)
1684 {
1685 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1686 "to expand for %s transport: %s", rawhome, tp->name,
1687 expand_string_message);
1688 return;
1689 }
1690 if (*deliver_home != '/')
1691 {
1692 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1693 "is not absolute for %s transport", deliver_home, tp->name);
1694 return;
1695 }
1696 }
1697
1698 /* See if either the transport or the address specifies a current directory,
1699 and if so, expand it. If nothing is set, use the home directory, unless it is
1700 also unset in which case use "/", which is assumed to be a directory to which
1701 all users have access. It is necessary to be in a visible directory for some
1702 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1703 2.5) require this. */
1704
1705 working_directory = (tp->current_dir != NULL)?
1706 tp->current_dir : addr->current_dir;
1707
1708 if (working_directory != NULL)
1709 {
1710 uschar *raw = working_directory;
1711 working_directory = expand_string(raw);
1712 if (working_directory == NULL)
1713 {
1714 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1715 "failed to expand for %s transport: %s", raw, tp->name,
1716 expand_string_message);
1717 return;
1718 }
1719 if (*working_directory != '/')
1720 {
1721 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1722 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1723 return;
1724 }
1725 }
1726 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1727
1728 /* If one of the return_output flags is set on the transport, create and open a
1729 file in the message log directory for the transport to write its output onto.
1730 This is mainly used by pipe transports. The file needs to be unique to the
1731 address. This feature is not available for shadow transports. */
1732
1733 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1734 tp->log_output || tp->log_fail_output))
1735 {
1736 uschar *error;
1737 addr->return_filename =
1738 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1739 message_id, getpid(), return_count++);
1740 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1741 if (addr->return_file < 0)
1742 {
1743 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1744 "to return message: %s", error, tp->name, strerror(errno));
1745 return;
1746 }
1747 }
1748
1749 /* Create the pipe for inter-process communication. */
1750
1751 if (pipe(pfd) != 0)
1752 {
1753 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1754 strerror(errno));
1755 return;
1756 }
1757
1758 /* Now fork the process to do the real work in the subprocess, but first
1759 ensure that all cached resources are freed so that the subprocess starts with
1760 a clean slate and doesn't interfere with the parent process. */
1761
1762 search_tidyup();
1763
1764 if ((pid = fork()) == 0)
1765 {
1766 BOOL replicate = TRUE;
1767
1768 /* Prevent core dumps, as we don't want them in users' home directories.
1769 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1770 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1771 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1772 complain if the error is "not supported".
1773
1774 There are two scenarios where changing the max limit has an effect. In one,
1775 the user is using a .forward and invoking a command of their choice via pipe;
1776 for these, we do need the max limit to be 0 unless the admin chooses to
1777 permit an increased limit. In the other, the command is invoked directly by
1778 the transport and is under administrator control, thus being able to raise
1779 the limit aids in debugging. So there's no general always-right answer.
1780
1781 Thus we inhibit core-dumps completely but let individual transports, while
1782 still root, re-raise the limits back up to aid debugging. We make the
1783 default be no core-dumps -- few enough people can use core dumps in
1784 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1785 */
1786
1787 #ifdef RLIMIT_CORE
1788 struct rlimit rl;
1789 rl.rlim_cur = 0;
1790 rl.rlim_max = 0;
1791 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1792 {
1793 #ifdef SETRLIMIT_NOT_SUPPORTED
1794 if (errno != ENOSYS && errno != ENOTSUP)
1795 #endif
1796 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1797 strerror(errno));
1798 }
1799 #endif
1800
1801 /* Reset the random number generator, so different processes don't all
1802 have the same sequence. */
1803
1804 random_seed = 0;
1805
1806 /* If the transport has a setup entry, call this first, while still
1807 privileged. (Appendfile uses this to expand quota, for example, while
1808 able to read private files.) */
1809
1810 if (addr->transport->setup != NULL)
1811 {
1812 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1813 &(addr->message)))
1814 {
1815 case DEFER:
1816 addr->transport_return = DEFER;
1817 goto PASS_BACK;
1818
1819 case FAIL:
1820 addr->transport_return = PANIC;
1821 goto PASS_BACK;
1822 }
1823 }
1824
1825 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1826 when the process becomes unprivileged, it won't be able to write to the
1827 process log. SIGHUP is ignored throughout exim, except when it is being
1828 run as a daemon. */
1829
1830 signal(SIGINT, SIG_IGN);
1831 signal(SIGTERM, SIG_IGN);
1832 signal(SIGUSR1, SIG_IGN);
1833
1834 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1835 half - for transports that exec things (e.g. pipe). Then set the required
1836 gid/uid. */
1837
1838 (void)close(pfd[pipe_read]);
1839 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1840 FD_CLOEXEC);
1841 exim_setugid(uid, gid, use_initgroups,
1842 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1843 addr->address, addr->transport->name));
1844
1845 DEBUG(D_deliver)
1846 {
1847 address_item *batched;
1848 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1849 for (batched = addr->next; batched != NULL; batched = batched->next)
1850 debug_printf("additional batched address: %s\n", batched->address);
1851 }
1852
1853 /* Set an appropriate working directory. */
1854
1855 if (Uchdir(working_directory) < 0)
1856 {
1857 addr->transport_return = DEFER;
1858 addr->basic_errno = errno;
1859 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1860 }
1861
1862 /* If successful, call the transport */
1863
1864 else
1865 {
1866 BOOL ok = TRUE;
1867 set_process_info("delivering %s to %s using %s", message_id,
1868 addr->local_part, addr->transport->name);
1869
1870 /* If a transport filter has been specified, set up its argument list.
1871 Any errors will get put into the address, and FALSE yielded. */
1872
1873 if (addr->transport->filter_command != NULL)
1874 {
1875 ok = transport_set_up_command(&transport_filter_argv,
1876 addr->transport->filter_command,
1877 TRUE, PANIC, addr, US"transport filter", NULL);
1878 transport_filter_timeout = addr->transport->filter_timeout;
1879 }
1880 else transport_filter_argv = NULL;
1881
1882 if (ok)
1883 {
1884 debug_print_string(addr->transport->debug_string);
1885 replicate = !(addr->transport->info->code)(addr->transport, addr);
1886 }
1887 }
1888
1889 /* Pass the results back down the pipe. If necessary, first replicate the
1890 status in the top address to the others in the batch. The label is the
1891 subject of a goto when a call to the transport's setup function fails. We
1892 pass the pointer to the transport back in case it got changed as a result of
1893 file_format in appendfile. */
1894
1895 PASS_BACK:
1896
1897 if (replicate) replicate_status(addr);
1898 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1899 {
1900 int i;
1901 int local_part_length = Ustrlen(addr2->local_part);
1902 uschar *s;
1903
1904 (void)write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int));
1905 (void)write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count));
1906 (void)write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags));
1907 (void)write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int));
1908 (void)write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int));
1909 (void)write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int));
1910 (void)write(pfd[pipe_write], (void *)&(addr2->transport),
1911 sizeof(transport_instance *));
1912
1913 /* For a file delivery, pass back the local part, in case the original
1914 was only part of the final delivery path. This gives more complete
1915 logging. */
1916
1917 if (testflag(addr2, af_file))
1918 {
1919 (void)write(pfd[pipe_write], (void *)&local_part_length, sizeof(int));
1920 (void)write(pfd[pipe_write], addr2->local_part, local_part_length);
1921 }
1922
1923 /* Now any messages */
1924
1925 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
1926 {
1927 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
1928 (void)write(pfd[pipe_write], (void *)&message_length, sizeof(int));
1929 if (message_length > 0) (void)write(pfd[pipe_write], s, message_length);
1930 }
1931 }
1932
1933 /* OK, this process is now done. Free any cached resources that it opened,
1934 and close the pipe we were writing down before exiting. */
1935
1936 (void)close(pfd[pipe_write]);
1937 search_tidyup();
1938 exit(EXIT_SUCCESS);
1939 }
1940
1941 /* Back in the main process: panic if the fork did not succeed. This seems
1942 better than returning an error - if forking is failing it is probably best
1943 not to try other deliveries for this message. */
1944
1945 if (pid < 0)
1946 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
1947 addr->address);
1948
1949 /* Read the pipe to get the delivery status codes and error messages. Our copy
1950 of the writing end must be closed first, as otherwise read() won't return zero
1951 on an empty pipe. We check that a status exists for each address before
1952 overwriting the address structure. If data is missing, the default DEFER status
1953 will remain. Afterwards, close the reading end. */
1954
1955 (void)close(pfd[pipe_write]);
1956
1957 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1958 {
1959 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
1960 if (len > 0)
1961 {
1962 int i;
1963 uschar **sptr;
1964
1965 addr2->transport_return = status;
1966 len = read(pfd[pipe_read], (void *)&transport_count,
1967 sizeof(transport_count));
1968 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
1969 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
1970 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
1971 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
1972 len = read(pfd[pipe_read], (void *)&(addr2->transport),
1973 sizeof(transport_instance *));
1974
1975 if (testflag(addr2, af_file))
1976 {
1977 int local_part_length;
1978 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
1979 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
1980 big_buffer[local_part_length] = 0;
1981 addr2->local_part = string_copy(big_buffer);
1982 }
1983
1984 for (i = 0, sptr = &(addr2->message); i < 2;
1985 i++, sptr = &(addr2->user_message))
1986 {
1987 int message_length;
1988 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
1989 if (message_length > 0)
1990 {
1991 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
1992 if (len > 0) *sptr = string_copy(big_buffer);
1993 }
1994 }
1995 }
1996
1997 else
1998 {
1999 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2000 "from delivery subprocess", addr2->unique);
2001 break;
2002 }
2003 }
2004
2005 (void)close(pfd[pipe_read]);
2006
2007 /* Unless shadowing, write all successful addresses immediately to the journal
2008 file, to ensure they are recorded asap. For homonymic addresses, use the base
2009 address plus the transport name. Failure to write the journal is panic-worthy,
2010 but don't stop, as it may prove possible subsequently to update the spool file
2011 in order to record the delivery. */
2012
2013 if (!shadowing)
2014 {
2015 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2016 {
2017 if (addr2->transport_return != OK) continue;
2018
2019 if (testflag(addr2, af_homonym))
2020 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2021 else
2022 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2023
2024 /* In the test harness, wait just a bit to let the subprocess finish off
2025 any debug output etc first. */
2026
2027 if (running_in_test_harness) millisleep(300);
2028
2029 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2030 len = Ustrlen(big_buffer);
2031 if (write(journal_fd, big_buffer, len) != len)
2032 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2033 big_buffer, strerror(errno));
2034 }
2035
2036 /* Ensure the journal file is pushed out to disk. */
2037
2038 if (EXIMfsync(journal_fd) < 0)
2039 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2040 strerror(errno));
2041 }
2042
2043 /* Wait for the process to finish. If it terminates with a non-zero code,
2044 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2045 status values of all the addresses as they are. Take care to handle the case
2046 when the subprocess doesn't seem to exist. This has been seen on one system
2047 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2048 happens, wait() doesn't recognize the termination of child processes. Exim now
2049 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2050
2051 while ((rc = wait(&status)) != pid)
2052 {
2053 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2054 {
2055 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2056 addr->transport->driver_name);
2057 status = 0;
2058 break;
2059 }
2060 }
2061
2062 if ((status & 0xffff) != 0)
2063 {
2064 int msb = (status >> 8) & 255;
2065 int lsb = status & 255;
2066 int code = (msb == 0)? (lsb & 0x7f) : msb;
2067 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2068 addr->special_action = SPECIAL_FREEZE;
2069 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2070 "status 0x%04x: %s %d",
2071 addr->transport->driver_name,
2072 status,
2073 (msb == 0)? "terminated by signal" : "exit code",
2074 code);
2075 }
2076
2077 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2078
2079 if (addr->special_action == SPECIAL_WARN &&
2080 addr->transport->warn_message != NULL)
2081 {
2082 int fd;
2083 uschar *warn_message;
2084
2085 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2086
2087 warn_message = expand_string(addr->transport->warn_message);
2088 if (warn_message == NULL)
2089 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2090 "message for %s transport): %s", addr->transport->warn_message,
2091 addr->transport->name, expand_string_message);
2092 else
2093 {
2094 pid_t pid = child_open_exim(&fd);
2095 if (pid > 0)
2096 {
2097 FILE *f = fdopen(fd, "wb");
2098 if (errors_reply_to != NULL &&
2099 !contains_header(US"Reply-To", warn_message))
2100 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2101 fprintf(f, "Auto-Submitted: auto-replied\n");
2102 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2103 fprintf(f, "%s", CS warn_message);
2104
2105 /* Close and wait for child process to complete, without a timeout. */
2106
2107 (void)fclose(f);
2108 (void)child_close(pid, 0);
2109 }
2110 }
2111
2112 addr->special_action = SPECIAL_NONE;
2113 }
2114 }
2115
2116
2117
2118 /*************************************************
2119 * Do local deliveries *
2120 *************************************************/
2121
2122 /* This function processes the list of addresses in addr_local. True local
2123 deliveries are always done one address at a time. However, local deliveries can
2124 be batched up in some cases. Typically this is when writing batched SMTP output
2125 files for use by some external transport mechanism, or when running local
2126 deliveries over LMTP.
2127
2128 Arguments: None
2129 Returns: Nothing
2130 */
2131
2132 static void
2133 do_local_deliveries(void)
2134 {
2135 open_db dbblock;
2136 open_db *dbm_file = NULL;
2137 time_t now = time(NULL);
2138
2139 /* Loop until we have exhausted the supply of local deliveries */
2140
2141 while (addr_local != NULL)
2142 {
2143 time_t delivery_start;
2144 int deliver_time;
2145 address_item *addr2, *addr3, *nextaddr;
2146 int logflags = LOG_MAIN;
2147 int logchar = dont_deliver? '*' : '=';
2148 transport_instance *tp;
2149
2150 /* Pick the first undelivered address off the chain */
2151
2152 address_item *addr = addr_local;
2153 addr_local = addr->next;
2154 addr->next = NULL;
2155
2156 DEBUG(D_deliver|D_transport)
2157 debug_printf("--------> %s <--------\n", addr->address);
2158
2159 /* An internal disaster if there is no transport. Should not occur! */
2160
2161 if ((tp = addr->transport) == NULL)
2162 {
2163 logflags |= LOG_PANIC;
2164 disable_logging = FALSE; /* Jic */
2165 addr->message =
2166 (addr->router != NULL)?
2167 string_sprintf("No transport set by %s router", addr->router->name)
2168 :
2169 string_sprintf("No transport set by system filter");
2170 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2171 continue;
2172 }
2173
2174 /* Check that this base address hasn't previously been delivered to this
2175 transport. The check is necessary at this point to handle homonymic addresses
2176 correctly in cases where the pattern of redirection changes between delivery
2177 attempts. Non-homonymic previous delivery is detected earlier, at routing
2178 time. */
2179
2180 if (previously_transported(addr, FALSE)) continue;
2181
2182 /* There are weird cases where logging is disabled */
2183
2184 disable_logging = tp->disable_logging;
2185
2186 /* Check for batched addresses and possible amalgamation. Skip all the work
2187 if either batch_max <= 1 or there aren't any other addresses for local
2188 delivery. */
2189
2190 if (tp->batch_max > 1 && addr_local != NULL)
2191 {
2192 int batch_count = 1;
2193 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2194 BOOL uses_lp = (testflag(addr, af_pfr) &&
2195 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2196 readconf_depends((driver_instance *)tp, US"local_part");
2197 uschar *batch_id = NULL;
2198 address_item **anchor = &addr_local;
2199 address_item *last = addr;
2200 address_item *next;
2201
2202 /* Expand the batch_id string for comparison with other addresses.
2203 Expansion failure suppresses batching. */
2204
2205 if (tp->batch_id != NULL)
2206 {
2207 deliver_set_expansions(addr);
2208 batch_id = expand_string(tp->batch_id);
2209 deliver_set_expansions(NULL);
2210 if (batch_id == NULL)
2211 {
2212 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2213 "in %s transport (%s): %s", tp->name, addr->address,
2214 expand_string_message);
2215 batch_count = tp->batch_max;
2216 }
2217 }
2218
2219 /* Until we reach the batch_max limit, pick off addresses which have the
2220 same characteristics. These are:
2221
2222 same transport
2223 not previously delivered (see comment about 50 lines above)
2224 same local part if the transport's configuration contains $local_part
2225 or if this is a file or pipe delivery from a redirection
2226 same domain if the transport's configuration contains $domain
2227 same errors address
2228 same additional headers
2229 same headers to be removed
2230 same uid/gid for running the transport
2231 same first host if a host list is set
2232 */
2233
2234 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2235 {
2236 BOOL ok =
2237 tp == next->transport &&
2238 !previously_transported(next, TRUE) &&
2239 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2240 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2241 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2242 same_strings(next->p.errors_address, addr->p.errors_address) &&
2243 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2244 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2245 same_ugid(tp, addr, next) &&
2246 ((addr->host_list == NULL && next->host_list == NULL) ||
2247 (addr->host_list != NULL && next->host_list != NULL &&
2248 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2249
2250 /* If the transport has a batch_id setting, batch_id will be non-NULL
2251 from the expansion outside the loop. Expand for this address and compare.
2252 Expansion failure makes this address ineligible for batching. */
2253
2254 if (ok && batch_id != NULL)
2255 {
2256 uschar *bid;
2257 address_item *save_nextnext = next->next;
2258 next->next = NULL; /* Expansion for a single address */
2259 deliver_set_expansions(next);
2260 next->next = save_nextnext;
2261 bid = expand_string(tp->batch_id);
2262 deliver_set_expansions(NULL);
2263 if (bid == NULL)
2264 {
2265 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2266 "in %s transport (%s): %s", tp->name, next->address,
2267 expand_string_message);
2268 ok = FALSE;
2269 }
2270 else ok = (Ustrcmp(batch_id, bid) == 0);
2271 }
2272
2273 /* Take address into batch if OK. */
2274
2275 if (ok)
2276 {
2277 *anchor = next->next; /* Include the address */
2278 next->next = NULL;
2279 last->next = next;
2280 last = next;
2281 batch_count++;
2282 }
2283 else anchor = &(next->next); /* Skip the address */
2284 }
2285 }
2286
2287 /* We now have one or more addresses that can be delivered in a batch. Check
2288 whether the transport is prepared to accept a message of this size. If not,
2289 fail them all forthwith. If the expansion fails, or does not yield an
2290 integer, defer delivery. */
2291
2292 if (tp->message_size_limit != NULL)
2293 {
2294 int rc = check_message_size(tp, addr);
2295 if (rc != OK)
2296 {
2297 replicate_status(addr);
2298 while (addr != NULL)
2299 {
2300 addr2 = addr->next;
2301 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2302 addr = addr2;
2303 }
2304 continue; /* With next batch of addresses */
2305 }
2306 }
2307
2308 /* If we are not running the queue, or if forcing, all deliveries will be
2309 attempted. Otherwise, we must respect the retry times for each address. Even
2310 when not doing this, we need to set up the retry key string, and determine
2311 whether a retry record exists, because after a successful delivery, a delete
2312 retry item must be set up. Keep the retry database open only for the duration
2313 of these checks, rather than for all local deliveries, because some local
2314 deliveries (e.g. to pipes) can take a substantial time. */
2315
2316 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2317 if (dbm_file == NULL)
2318 {
2319 DEBUG(D_deliver|D_retry|D_hints_lookup)
2320 debug_printf("no retry data available\n");
2321 }
2322
2323 addr2 = addr;
2324 addr3 = NULL;
2325 while (addr2 != NULL)
2326 {
2327 BOOL ok = TRUE; /* to deliver this address */
2328 uschar *retry_key;
2329
2330 /* Set up the retry key to include the domain or not, and change its
2331 leading character from "R" to "T". Must make a copy before doing this,
2332 because the old key may be pointed to from a "delete" retry item after
2333 a routing delay. */
2334
2335 retry_key = string_copy(
2336 (tp->retry_use_local_part)? addr2->address_retry_key :
2337 addr2->domain_retry_key);
2338 *retry_key = 'T';
2339
2340 /* Inspect the retry data. If there is no hints file, delivery happens. */
2341
2342 if (dbm_file != NULL)
2343 {
2344 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2345
2346 /* If there is no retry record, delivery happens. If there is,
2347 remember it exists so it can be deleted after a successful delivery. */
2348
2349 if (retry_record != NULL)
2350 {
2351 setflag(addr2, af_lt_retry_exists);
2352
2353 /* A retry record exists for this address. If queue running and not
2354 forcing, inspect its contents. If the record is too old, or if its
2355 retry time has come, or if it has passed its cutoff time, delivery
2356 will go ahead. */
2357
2358 DEBUG(D_retry)
2359 {
2360 debug_printf("retry record exists: age=%s ",
2361 readconf_printtime(now - retry_record->time_stamp));
2362 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2363 debug_printf(" time to retry = %s expired = %d\n",
2364 readconf_printtime(retry_record->next_try - now),
2365 retry_record->expired);
2366 }
2367
2368 if (queue_running && !deliver_force)
2369 {
2370 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2371 (now >= retry_record->next_try) ||
2372 retry_record->expired;
2373
2374 /* If we haven't reached the retry time, there is one more check
2375 to do, which is for the ultimate address timeout. */
2376
2377 if (!ok)
2378 {
2379 retry_config *retry =
2380 retry_find_config(retry_key+2, addr2->domain,
2381 retry_record->basic_errno,
2382 retry_record->more_errno);
2383
2384 DEBUG(D_deliver|D_retry)
2385 {
2386 debug_printf("retry time not reached for %s: "
2387 "checking ultimate address timeout\n", addr2->address);
2388 debug_printf(" now=%d first_failed=%d next_try=%d expired=%d\n",
2389 (int)now, (int)retry_record->first_failed,
2390 (int)retry_record->next_try, retry_record->expired);
2391 }
2392
2393 if (retry != NULL && retry->rules != NULL)
2394 {
2395 retry_rule *last_rule;
2396 for (last_rule = retry->rules;
2397 last_rule->next != NULL;
2398 last_rule = last_rule->next);
2399 DEBUG(D_deliver|D_retry)
2400 debug_printf(" received_time=%d diff=%d timeout=%d\n",
2401 received_time, (int)now - received_time, last_rule->timeout);
2402 if (now - received_time > last_rule->timeout) ok = TRUE;
2403 }
2404 else
2405 {
2406 DEBUG(D_deliver|D_retry)
2407 debug_printf("no retry rule found: assume timed out\n");
2408 ok = TRUE; /* No rule => timed out */
2409 }
2410
2411 DEBUG(D_deliver|D_retry)
2412 {
2413 if (ok) debug_printf("on queue longer than maximum retry for "
2414 "address - allowing delivery\n");
2415 }
2416 }
2417 }
2418 }
2419 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2420 }
2421
2422 /* This address is to be delivered. Leave it on the chain. */
2423
2424 if (ok)
2425 {
2426 addr3 = addr2;
2427 addr2 = addr2->next;
2428 }
2429
2430 /* This address is to be deferred. Take it out of the chain, and
2431 post-process it as complete. Must take it out of the chain first,
2432 because post processing puts it on another chain. */
2433
2434 else
2435 {
2436 address_item *this = addr2;
2437 this->message = US"Retry time not yet reached";
2438 this->basic_errno = ERRNO_LRETRY;
2439 if (addr3 == NULL) addr2 = addr = addr2->next;
2440 else addr2 = addr3->next = addr2->next;
2441 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2442 }
2443 }
2444
2445 if (dbm_file != NULL) dbfn_close(dbm_file);
2446
2447 /* If there are no addresses left on the chain, they all deferred. Loop
2448 for the next set of addresses. */
2449
2450 if (addr == NULL) continue;
2451
2452 /* So, finally, we do have some addresses that can be passed to the
2453 transport. Before doing so, set up variables that are relevant to a
2454 single delivery. */
2455
2456 deliver_set_expansions(addr);
2457 delivery_start = time(NULL);
2458 deliver_local(addr, FALSE);
2459 deliver_time = (int)(time(NULL) - delivery_start);
2460
2461 /* If a shadow transport (which must perforce be another local transport), is
2462 defined, and its condition is met, we must pass the message to the shadow
2463 too, but only those addresses that succeeded. We do this by making a new
2464 chain of addresses - also to keep the original chain uncontaminated. We must
2465 use a chain rather than doing it one by one, because the shadow transport may
2466 batch.
2467
2468 NOTE: if the condition fails because of a lookup defer, there is nothing we
2469 can do! */
2470
2471 if (tp->shadow != NULL &&
2472 (tp->shadow_condition == NULL ||
2473 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2474 {
2475 transport_instance *stp;
2476 address_item *shadow_addr = NULL;
2477 address_item **last = &shadow_addr;
2478
2479 for (stp = transports; stp != NULL; stp = stp->next)
2480 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2481
2482 if (stp == NULL)
2483 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2484 tp->shadow);
2485
2486 /* Pick off the addresses that have succeeded, and make clones. Put into
2487 the shadow_message field a pointer to the shadow_message field of the real
2488 address. */
2489
2490 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2491 {
2492 if (addr2->transport_return != OK) continue;
2493 addr3 = store_get(sizeof(address_item));
2494 *addr3 = *addr2;
2495 addr3->next = NULL;
2496 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2497 addr3->transport = stp;
2498 addr3->transport_return = DEFER;
2499 addr3->return_filename = NULL;
2500 addr3->return_file = -1;
2501 *last = addr3;
2502 last = &(addr3->next);
2503 }
2504
2505 /* If we found any addresses to shadow, run the delivery, and stick any
2506 message back into the shadow_message field in the original. */
2507
2508 if (shadow_addr != NULL)
2509 {
2510 int save_count = transport_count;
2511
2512 DEBUG(D_deliver|D_transport)
2513 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2514 deliver_local(shadow_addr, TRUE);
2515
2516 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2517 {
2518 int sresult = shadow_addr->transport_return;
2519 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2520 string_sprintf(" ST=%s", stp->name) :
2521 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2522 (shadow_addr->basic_errno <= 0)?
2523 US"" : US strerror(shadow_addr->basic_errno),
2524 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2525 US"" : US": ",
2526 (shadow_addr->message != NULL)? shadow_addr->message :
2527 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2528
2529 DEBUG(D_deliver|D_transport)
2530 debug_printf("%s shadow transport returned %s for %s\n",
2531 stp->name,
2532 (sresult == OK)? "OK" :
2533 (sresult == DEFER)? "DEFER" :
2534 (sresult == FAIL)? "FAIL" :
2535 (sresult == PANIC)? "PANIC" : "?",
2536 shadow_addr->address);
2537 }
2538
2539 DEBUG(D_deliver|D_transport)
2540 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2541
2542 transport_count = save_count; /* Restore original transport count */
2543 }
2544 }
2545
2546 /* Cancel the expansions that were set up for the delivery. */
2547
2548 deliver_set_expansions(NULL);
2549
2550 /* Now we can process the results of the real transport. We must take each
2551 address off the chain first, because post_process_one() puts it on another
2552 chain. */
2553
2554 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2555 {
2556 int result = addr2->transport_return;
2557 nextaddr = addr2->next;
2558
2559 DEBUG(D_deliver|D_transport)
2560 debug_printf("%s transport returned %s for %s\n",
2561 tp->name,
2562 (result == OK)? "OK" :
2563 (result == DEFER)? "DEFER" :
2564 (result == FAIL)? "FAIL" :
2565 (result == PANIC)? "PANIC" : "?",
2566 addr2->address);
2567
2568 /* If there is a retry_record, or if delivery is deferred, build a retry
2569 item for setting a new retry time or deleting the old retry record from
2570 the database. These items are handled all together after all addresses
2571 have been handled (so the database is open just for a short time for
2572 updating). */
2573
2574 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2575 {
2576 int flags = (result == DEFER)? 0 : rf_delete;
2577 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2578 addr2->address_retry_key : addr2->domain_retry_key);
2579 *retry_key = 'T';
2580 retry_add_item(addr2, retry_key, flags);
2581 }
2582
2583 /* Done with this address */
2584
2585 if (result == OK) addr2->more_errno = deliver_time;
2586 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2587
2588 /* If a pipe delivery generated text to be sent back, the result may be
2589 changed to FAIL, and we must copy this for subsequent addresses in the
2590 batch. */
2591
2592 if (addr2->transport_return != result)
2593 {
2594 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2595 {
2596 addr3->transport_return = addr2->transport_return;
2597 addr3->basic_errno = addr2->basic_errno;
2598 addr3->message = addr2->message;
2599 }
2600 result = addr2->transport_return;
2601 }
2602
2603 /* Whether or not the result was changed to FAIL, we need to copy the
2604 return_file value from the first address into all the addresses of the
2605 batch, so they are all listed in the error message. */
2606
2607 addr2->return_file = addr->return_file;
2608
2609 /* Change log character for recording successful deliveries. */
2610
2611 if (result == OK) logchar = '-';
2612 }
2613 } /* Loop back for next batch of addresses */
2614 }
2615
2616
2617
2618
2619 /*************************************************
2620 * Sort remote deliveries *
2621 *************************************************/
2622
2623 /* This function is called if remote_sort_domains is set. It arranges that the
2624 chain of addresses for remote deliveries is ordered according to the strings
2625 specified. Try to make this shuffling reasonably efficient by handling
2626 sequences of addresses rather than just single ones.
2627
2628 Arguments: None
2629 Returns: Nothing
2630 */
2631
2632 static void
2633 sort_remote_deliveries(void)
2634 {
2635 int sep = 0;
2636 address_item **aptr = &addr_remote;
2637 uschar *listptr = remote_sort_domains;
2638 uschar *pattern;
2639 uschar patbuf[256];
2640
2641 while (*aptr != NULL &&
2642 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2643 != NULL)
2644 {
2645 address_item *moved = NULL;
2646 address_item **bptr = &moved;
2647
2648 while (*aptr != NULL)
2649 {
2650 address_item **next;
2651 deliver_domain = (*aptr)->domain; /* set $domain */
2652 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2653 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2654 {
2655 aptr = &((*aptr)->next);
2656 continue;
2657 }
2658
2659 next = &((*aptr)->next);
2660 while (*next != NULL &&
2661 (deliver_domain = (*next)->domain, /* Set $domain */
2662 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2663 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2664 next = &((*next)->next);
2665
2666 /* If the batch of non-matchers is at the end, add on any that were
2667 extracted further up the chain, and end this iteration. Otherwise,
2668 extract them from the chain and hang on the moved chain. */
2669
2670 if (*next == NULL)
2671 {
2672 *next = moved;
2673 break;
2674 }
2675
2676 *bptr = *aptr;
2677 *aptr = *next;
2678 *next = NULL;
2679 bptr = next;
2680 aptr = &((*aptr)->next);
2681 }
2682
2683 /* If the loop ended because the final address matched, *aptr will
2684 be NULL. Add on to the end any extracted non-matching addresses. If
2685 *aptr is not NULL, the loop ended via "break" when *next is null, that
2686 is, there was a string of non-matching addresses at the end. In this
2687 case the extracted addresses have already been added on the end. */
2688
2689 if (*aptr == NULL) *aptr = moved;
2690 }
2691
2692 DEBUG(D_deliver)
2693 {
2694 address_item *addr;
2695 debug_printf("remote addresses after sorting:\n");
2696 for (addr = addr_remote; addr != NULL; addr = addr->next)
2697 debug_printf(" %s\n", addr->address);
2698 }
2699 }
2700
2701
2702
2703 /*************************************************
2704 * Read from pipe for remote delivery subprocess *
2705 *************************************************/
2706
2707 /* This function is called when the subprocess is complete, but can also be
2708 called before it is complete, in order to empty a pipe that is full (to prevent
2709 deadlock). It must therefore keep track of its progress in the parlist data
2710 block.
2711
2712 We read the pipe to get the delivery status codes and a possible error message
2713 for each address, optionally preceded by unusability data for the hosts and
2714 also by optional retry data.
2715
2716 Read in large chunks into the big buffer and then scan through, interpreting
2717 the data therein. In most cases, only a single read will be necessary. No
2718 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2719 that we read the next chunk when there is less than 2500 bytes left in the
2720 non-final chunk, we can assume each item is complete in the buffer before
2721 handling it. Each item is written using a single write(), which is atomic for
2722 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2723 often bigger) so even if we are reading while the subprocess is still going, we
2724 should never have only a partial item in the buffer.
2725
2726 Argument:
2727 poffset the offset of the parlist item
2728 eop TRUE if the process has completed
2729
2730 Returns: TRUE if the terminating 'Z' item has been read,
2731 or there has been a disaster (i.e. no more data needed);
2732 FALSE otherwise
2733 */
2734
2735 static BOOL
2736 par_read_pipe(int poffset, BOOL eop)
2737 {
2738 host_item *h;
2739 pardata *p = parlist + poffset;
2740 address_item *addrlist = p->addrlist;
2741 address_item *addr = p->addr;
2742 pid_t pid = p->pid;
2743 int fd = p->fd;
2744 uschar *endptr = big_buffer;
2745 uschar *ptr = endptr;
2746 uschar *msg = p->msg;
2747 BOOL done = p->done;
2748 BOOL unfinished = TRUE;
2749
2750 /* Loop through all items, reading from the pipe when necessary. The pipe
2751 is set up to be non-blocking, but there are two different Unix mechanisms in
2752 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2753 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2754 which returns 0 for both end of file and no more data. We distinguish the
2755 two cases by taking 0 as end of file only when we know the process has
2756 completed.
2757
2758 Each separate item is written to the pipe in a single write(), and as they are
2759 all short items, the writes will all be atomic and we should never find
2760 ourselves in the position of having read an incomplete item. "Short" in this
2761 case can mean up to about 1K in the case when there is a long error message
2762 associated with an address. */
2763
2764 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2765 (int)p->pid, eop? "ended" : "not ended");
2766
2767 while (!done)
2768 {
2769 retry_item *r, **rp;
2770 int remaining = endptr - ptr;
2771
2772 /* Read (first time) or top up the chars in the buffer if necessary.
2773 There will be only one read if we get all the available data (i.e. don't
2774 fill the buffer completely). */
2775
2776 if (remaining < 2500 && unfinished)
2777 {
2778 int len;
2779 int available = big_buffer_size - remaining;
2780
2781 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2782
2783 ptr = big_buffer;
2784 endptr = big_buffer + remaining;
2785 len = read(fd, endptr, available);
2786
2787 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2788
2789 /* If the result is EAGAIN and the process is not complete, just
2790 stop reading any more and process what we have already. */
2791
2792 if (len < 0)
2793 {
2794 if (!eop && errno == EAGAIN) len = 0; else
2795 {
2796 msg = string_sprintf("failed to read pipe from transport process "
2797 "%d for transport %s: %s", pid, addr->transport->driver_name,
2798 strerror(errno));
2799 break;
2800 }
2801 }
2802
2803 /* If the length is zero (eof or no-more-data), just process what we
2804 already have. Note that if the process is still running and we have
2805 read all the data in the pipe (but less that "available") then we
2806 won't read any more, as "unfinished" will get set FALSE. */
2807
2808 endptr += len;
2809 unfinished = len == available;
2810 }
2811
2812 /* If we are at the end of the available data, exit the loop. */
2813
2814 if (ptr >= endptr) break;
2815
2816 /* Handle each possible type of item, assuming the complete item is
2817 available in store. */
2818
2819 switch (*ptr++)
2820 {
2821 /* Host items exist only if any hosts were marked unusable. Match
2822 up by checking the IP address. */
2823
2824 case 'H':
2825 for (h = addrlist->host_list; h != NULL; h = h->next)
2826 {
2827 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2828 h->status = ptr[0];
2829 h->why = ptr[1];
2830 }
2831 ptr += 2;
2832 while (*ptr++);
2833 break;
2834
2835 /* Retry items are sent in a preceding R item for each address. This is
2836 kept separate to keep each message short enough to guarantee it won't
2837 be split in the pipe. Hopefully, in the majority of cases, there won't in
2838 fact be any retry items at all.
2839
2840 The complete set of retry items might include an item to delete a
2841 routing retry if there was a previous routing delay. However, routing
2842 retries are also used when a remote transport identifies an address error.
2843 In that case, there may also be an "add" item for the same key. Arrange
2844 that a "delete" item is dropped in favour of an "add" item. */
2845
2846 case 'R':
2847 if (addr == NULL) goto ADDR_MISMATCH;
2848
2849 DEBUG(D_deliver|D_retry)
2850 debug_printf("reading retry information for %s from subprocess\n",
2851 ptr+1);
2852
2853 /* Cut out any "delete" items on the list. */
2854
2855 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2856 {
2857 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2858 {
2859 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2860 *rp = r->next; /* Excise a delete item */
2861 DEBUG(D_deliver|D_retry)
2862 debug_printf(" existing delete item dropped\n");
2863 }
2864 }
2865
2866 /* We want to add a delete item only if there is no non-delete item;
2867 however we still have to step ptr through the data. */
2868
2869 if (r == NULL || (*ptr & rf_delete) == 0)
2870 {
2871 r = store_get(sizeof(retry_item));
2872 r->next = addr->retries;
2873 addr->retries = r;
2874 r->flags = *ptr++;
2875 r->key = string_copy(ptr);
2876 while (*ptr++);
2877 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2878 ptr += sizeof(r->basic_errno);
2879 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2880 ptr += sizeof(r->more_errno);
2881 r->message = (*ptr)? string_copy(ptr) : NULL;
2882 DEBUG(D_deliver|D_retry)
2883 debug_printf(" added %s item\n",
2884 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2885 }
2886
2887 else
2888 {
2889 DEBUG(D_deliver|D_retry)
2890 debug_printf(" delete item not added: non-delete item exists\n");
2891 ptr++;
2892 while(*ptr++);
2893 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2894 }
2895
2896 while(*ptr++);
2897 break;
2898
2899 /* Put the amount of data written into the parlist block */
2900
2901 case 'S':
2902 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2903 ptr += sizeof(transport_count);
2904 break;
2905
2906 /* Address items are in the order of items on the address chain. We
2907 remember the current address value in case this function is called
2908 several times to empty the pipe in stages. Information about delivery
2909 over TLS is sent in a preceding X item for each address. We don't put
2910 it in with the other info, in order to keep each message short enough to
2911 guarantee it won't be split in the pipe. */
2912
2913 #ifdef SUPPORT_TLS
2914 case 'X':
2915 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2916 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2917 while (*ptr++);
2918 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2919 while (*ptr++);
2920 break;
2921 #endif
2922
2923 case 'C': /* client authenticator information */
2924 switch (*ptr++)
2925 {
2926 case '1':
2927 smtp_authenticated = TRUE;
2928 client_authenticator = (*ptr)? string_copy(ptr) : NULL;
2929 break;
2930 case '2':
2931 client_authenticated_id = (*ptr)? string_copy(ptr) : NULL;
2932 break;
2933 }
2934 while (*ptr++);
2935 break;
2936
2937 case 'A':
2938 if (addr == NULL)
2939 {
2940 ADDR_MISMATCH:
2941 msg = string_sprintf("address count mismatch for data read from pipe "
2942 "for transport process %d for transport %s", pid,
2943 addrlist->transport->driver_name);
2944 done = TRUE;
2945 break;
2946 }
2947
2948 addr->transport_return = *ptr++;
2949 addr->special_action = *ptr++;
2950 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2951 ptr += sizeof(addr->basic_errno);
2952 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2953 ptr += sizeof(addr->more_errno);
2954 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2955 ptr += sizeof(addr->flags);
2956 addr->message = (*ptr)? string_copy(ptr) : NULL;
2957 while(*ptr++);
2958 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2959 while(*ptr++);
2960
2961 /* Always two strings for host information, followed by the port number */
2962
2963 if (*ptr != 0)
2964 {
2965 h = store_get(sizeof(host_item));
2966 h->name = string_copy(ptr);
2967 while (*ptr++);
2968 h->address = string_copy(ptr);
2969 while(*ptr++);
2970 memcpy(&(h->port), ptr, sizeof(h->port));
2971 ptr += sizeof(h->port);
2972 addr->host_used = h;
2973 }
2974 else ptr++;
2975
2976 /* Finished with this address */
2977
2978 addr = addr->next;
2979 break;
2980
2981 /* Z marks the logical end of the data. It is followed by '0' if
2982 continue_transport was NULL at the end of transporting, otherwise '1'.
2983 We need to know when it becomes NULL during a delivery down a passed SMTP
2984 channel so that we don't try to pass anything more down it. Of course, for
2985 most normal messages it will remain NULL all the time. */
2986
2987 case 'Z':
2988 if (*ptr == '0')
2989 {
2990 continue_transport = NULL;
2991 continue_hostname = NULL;
2992 }
2993 done = TRUE;
2994 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
2995 break;
2996
2997 /* Anything else is a disaster. */
2998
2999 default:
3000 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3001 "process %d for transport %s", ptr[-1], pid,
3002 addr->transport->driver_name);
3003 done = TRUE;
3004 break;
3005 }
3006 }
3007
3008 /* The done flag is inspected externally, to determine whether or not to
3009 call the function again when the process finishes. */
3010
3011 p->done = done;
3012
3013 /* If the process hadn't finished, and we haven't seen the end of the data
3014 or suffered a disaster, update the rest of the state, and return FALSE to
3015 indicate "not finished". */
3016
3017 if (!eop && !done)
3018 {
3019 p->addr = addr;
3020 p->msg = msg;
3021 return FALSE;
3022 }
3023
3024 /* Close our end of the pipe, to prevent deadlock if the far end is still
3025 pushing stuff into it. */
3026
3027 (void)close(fd);
3028 p->fd = -1;
3029
3030 /* If we have finished without error, but haven't had data for every address,
3031 something is wrong. */
3032
3033 if (msg == NULL && addr != NULL)
3034 msg = string_sprintf("insufficient address data read from pipe "
3035 "for transport process %d for transport %s", pid,
3036 addr->transport->driver_name);
3037
3038 /* If an error message is set, something has gone wrong in getting back
3039 the delivery data. Put the message into each address and freeze it. */
3040
3041 if (msg != NULL)
3042 {
3043 for (addr = addrlist; addr != NULL; addr = addr->next)
3044 {
3045 addr->transport_return = DEFER;
3046 addr->special_action = SPECIAL_FREEZE;
3047 addr->message = msg;
3048 }
3049 }
3050
3051 /* Return TRUE to indicate we have got all we need from this process, even
3052 if it hasn't actually finished yet. */
3053
3054 return TRUE;
3055 }
3056
3057
3058
3059 /*************************************************
3060 * Post-process a set of remote addresses *
3061 *************************************************/
3062
3063 /* Do what has to be done immediately after a remote delivery for each set of
3064 addresses, then re-write the spool if necessary. Note that post_process_one
3065 puts the address on an appropriate queue; hence we must fish off the next
3066 one first. This function is also called if there is a problem with setting
3067 up a subprocess to do a remote delivery in parallel. In this case, the final
3068 argument contains a message, and the action must be forced to DEFER.
3069
3070 Argument:
3071 addr pointer to chain of address items
3072 logflags flags for logging
3073 msg NULL for normal cases; -> error message for unexpected problems
3074 fallback TRUE if processing fallback hosts
3075
3076 Returns: nothing
3077 */
3078
3079 static void
3080 remote_post_process(address_item *addr, int logflags, uschar *msg,
3081 BOOL fallback)
3082 {
3083 host_item *h;
3084
3085 /* If any host addresses were found to be unusable, add them to the unusable
3086 tree so that subsequent deliveries don't try them. */
3087
3088 for (h = addr->host_list; h != NULL; h = h->next)
3089 {
3090 if (h->address == NULL) continue;
3091 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3092 }
3093
3094 /* Now handle each address on the chain. The transport has placed '=' or '-'
3095 into the special_action field for each successful delivery. */
3096
3097 while (addr != NULL)
3098 {
3099 address_item *next = addr->next;
3100
3101 /* If msg == NULL (normal processing) and the result is DEFER and we are
3102 processing the main hosts and there are fallback hosts available, put the
3103 address on the list for fallback delivery. */
3104
3105 if (addr->transport_return == DEFER &&
3106 addr->fallback_hosts != NULL &&
3107 !fallback &&
3108 msg == NULL)
3109 {
3110 addr->host_list = addr->fallback_hosts;
3111 addr->next = addr_fallback;
3112 addr_fallback = addr;
3113 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3114 }
3115
3116 /* If msg is set (=> unexpected problem), set it in the address before
3117 doing the ordinary post processing. */
3118
3119 else
3120 {
3121 if (msg != NULL)
3122 {
3123 addr->message = msg;
3124 addr->transport_return = DEFER;
3125 }
3126 (void)post_process_one(addr, addr->transport_return, logflags,
3127 DTYPE_TRANSPORT, addr->special_action);
3128 }
3129
3130 /* Next address */
3131
3132 addr = next;
3133 }
3134
3135 /* If we have just delivered down a passed SMTP channel, and that was
3136 the last address, the channel will have been closed down. Now that
3137 we have logged that delivery, set continue_sequence to 1 so that
3138 any subsequent deliveries don't get "*" incorrectly logged. */
3139
3140 if (continue_transport == NULL) continue_sequence = 1;
3141 }
3142
3143
3144
3145 /*************************************************
3146 * Wait for one remote delivery subprocess *
3147 *************************************************/
3148
3149 /* This function is called while doing remote deliveries when either the
3150 maximum number of processes exist and we need one to complete so that another
3151 can be created, or when waiting for the last ones to complete. It must wait for
3152 the completion of one subprocess, empty the control block slot, and return a
3153 pointer to the address chain.
3154
3155 Arguments: none
3156 Returns: pointer to the chain of addresses handled by the process;
3157 NULL if no subprocess found - this is an unexpected error
3158 */
3159
3160 static address_item *
3161 par_wait(void)
3162 {
3163 int poffset, status;
3164 address_item *addr, *addrlist;
3165 pid_t pid;
3166
3167 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3168 "to finish", message_id);
3169
3170 /* Loop until either a subprocess completes, or there are no subprocesses in
3171 existence - in which case give an error return. We cannot proceed just by
3172 waiting for a completion, because a subprocess may have filled up its pipe, and
3173 be waiting for it to be emptied. Therefore, if no processes have finished, we
3174 wait for one of the pipes to acquire some data by calling select(), with a
3175 timeout just in case.
3176
3177 The simple approach is just to iterate after reading data from a ready pipe.
3178 This leads to non-ideal behaviour when the subprocess has written its final Z
3179 item, closed the pipe, and is in the process of exiting (the common case). A
3180 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3181 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3182 actually finished.
3183
3184 To avoid this, if all the data that is needed has been read from a subprocess
3185 after select(), an explicit wait() for it is done. We know that all it is doing
3186 is writing to the pipe and then exiting, so the wait should not be long.
3187
3188 The non-blocking waitpid() is to some extent just insurance; if we could
3189 reliably detect end-of-file on the pipe, we could always know when to do a
3190 blocking wait() for a completed process. However, because some systems use
3191 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3192 use code that functions without the need to recognize EOF.
3193
3194 There's a double loop here just in case we end up with a process that is not in
3195 the list of remote delivery processes. Something has obviously gone wrong if
3196 this is the case. (For example, a process that is incorrectly left over from
3197 routing or local deliveries might be found.) The damage can be minimized by
3198 looping back and looking for another process. If there aren't any, the error
3199 return will happen. */
3200
3201 for (;;) /* Normally we do not repeat this loop */
3202 {
3203 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3204 {
3205 struct timeval tv;
3206 fd_set select_pipes;
3207 int maxpipe, readycount;
3208
3209 /* A return value of -1 can mean several things. If errno != ECHILD, it
3210 either means invalid options (which we discount), or that this process was
3211 interrupted by a signal. Just loop to try the waitpid() again.
3212
3213 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3214 in existence. This should never happen, and is an unexpected error.
3215 However, there is a nasty complication when running under Linux. If "strace
3216 -f" is being used under Linux to trace this process and its children,
3217 subprocesses are "stolen" from their parents and become the children of the
3218 tracing process. A general wait such as the one we've just obeyed returns
3219 as if there are no children while subprocesses are running. Once a
3220 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3221 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3222 palliative.
3223
3224 This does not happen using "truss" on Solaris, nor (I think) with other
3225 tracing facilities on other OS. It seems to be specific to Linux.
3226
3227 What we do to get round this is to use kill() to see if any of our
3228 subprocesses are still in existence. If kill() gives an OK return, we know
3229 it must be for one of our processes - it can't be for a re-use of the pid,
3230 because if our process had finished, waitpid() would have found it. If any
3231 of our subprocesses are in existence, we proceed to use select() as if
3232 waitpid() had returned zero. I think this is safe. */
3233
3234 if (pid < 0)
3235 {
3236 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3237
3238 DEBUG(D_deliver)
3239 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3240 "for process existence\n");
3241
3242 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3243 {
3244 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3245 {
3246 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3247 "stolen by strace\n", (int)pid);
3248 break; /* With poffset set */
3249 }
3250 }
3251
3252 if (poffset >= remote_max_parallel)
3253 {
3254 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3255 return NULL; /* This is the error return */
3256 }
3257 }
3258
3259 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3260 been handled above. A return value of zero means that there is at least one
3261 subprocess, but there are no completed subprocesses. See if any pipes are
3262 ready with any data for reading. */
3263
3264 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3265
3266 maxpipe = 0;
3267 FD_ZERO(&select_pipes);
3268 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3269 {
3270 if (parlist[poffset].pid != 0)
3271 {
3272 int fd = parlist[poffset].fd;
3273 FD_SET(fd, &select_pipes);
3274 if (fd > maxpipe) maxpipe = fd;
3275 }
3276 }
3277
3278 /* Stick in a 60-second timeout, just in case. */
3279
3280 tv.tv_sec = 60;
3281 tv.tv_usec = 0;
3282
3283 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3284 NULL, NULL, &tv);
3285
3286 /* Scan through the pipes and read any that are ready; use the count
3287 returned by select() to stop when there are no more. Select() can return
3288 with no processes (e.g. if interrupted). This shouldn't matter.
3289
3290 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3291 read, or there was a disaster. In either case, we are finished with this
3292 process. Do an explicit wait() for the process and break the main loop if
3293 it succeeds.
3294
3295 It turns out that we have to deal with the case of an interrupted system
3296 call, which can happen on some operating systems if the signal handling is
3297 set up to do that by default. */
3298
3299 for (poffset = 0;
3300 readycount > 0 && poffset < remote_max_parallel;
3301 poffset++)
3302 {
3303 if ((pid = parlist[poffset].pid) != 0 &&
3304 FD_ISSET(parlist[poffset].fd, &select_pipes))
3305 {
3306 readycount--;
3307 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3308 {
3309 for (;;) /* Loop for signals */
3310 {
3311 pid_t endedpid = waitpid(pid, &status, 0);
3312 if (endedpid == pid) goto PROCESS_DONE;
3313 if (endedpid != (pid_t)(-1) || errno != EINTR)
3314 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3315 "%d (errno = %d) from waitpid() for process %d",
3316 (int)endedpid, errno, (int)pid);
3317 }
3318 }
3319 }
3320 }
3321
3322 /* Now go back and look for a completed subprocess again. */
3323 }
3324
3325 /* A completed process was detected by the non-blocking waitpid(). Find the
3326 data block that corresponds to this subprocess. */
3327
3328 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3329 if (pid == parlist[poffset].pid) break;
3330
3331 /* Found the data block; this is a known remote delivery process. We don't
3332 need to repeat the outer loop. This should be what normally happens. */
3333
3334 if (poffset < remote_max_parallel) break;
3335
3336 /* This situation is an error, but it's probably better to carry on looking
3337 for another process than to give up (as we used to do). */
3338
3339 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3340 "transport process list", pid);
3341 } /* End of the "for" loop */
3342
3343 /* Come here when all the data was completely read after a select(), and
3344 the process in pid has been wait()ed for. */
3345
3346 PROCESS_DONE:
3347
3348 DEBUG(D_deliver)
3349 {
3350 if (status == 0)
3351 debug_printf("remote delivery process %d ended\n", (int)pid);
3352 else
3353 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3354 status);
3355 }
3356
3357 set_process_info("delivering %s", message_id);
3358
3359 /* Get the chain of processed addresses */
3360
3361 addrlist = parlist[poffset].addrlist;
3362
3363 /* If the process did not finish cleanly, record an error and freeze (except
3364 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3365 in case the delivery did actually happen. */
3366
3367 if ((status & 0xffff) != 0)
3368 {
3369 uschar *msg;
3370 int msb = (status >> 8) & 255;
3371 int lsb = status & 255;
3372 int code = (msb == 0)? (lsb & 0x7f) : msb;
3373
3374 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3375 "%s %d",
3376 addrlist->transport->driver_name,
3377 status,
3378 (msb == 0)? "terminated by signal" : "exit code",
3379 code);
3380
3381 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3382 addrlist->special_action = SPECIAL_FREEZE;
3383
3384 for (addr = addrlist; addr != NULL; addr = addr->next)
3385 {
3386 addr->transport_return = DEFER;
3387 addr->message = msg;
3388 }
3389
3390 remove_journal = FALSE;
3391 }
3392
3393 /* Else complete reading the pipe to get the result of the delivery, if all
3394 the data has not yet been obtained. */
3395
3396 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3397
3398 /* Put the data count and return path into globals, mark the data slot unused,
3399 decrement the count of subprocesses, and return the address chain. */
3400
3401 transport_count = parlist[poffset].transport_count;
3402 used_return_path = parlist[poffset].return_path;
3403 parlist[poffset].pid = 0;
3404 parcount--;
3405 return addrlist;
3406 }
3407
3408
3409
3410 /*************************************************
3411 * Wait for subprocesses and post-process *
3412 *************************************************/
3413
3414 /* This function waits for subprocesses until the number that are still running
3415 is below a given threshold. For each complete subprocess, the addresses are
3416 post-processed. If we can't find a running process, there is some shambles.
3417 Better not bomb out, as that might lead to multiple copies of the message. Just
3418 log and proceed as if all done.
3419
3420 Arguments:
3421 max maximum number of subprocesses to leave running
3422 fallback TRUE if processing fallback hosts
3423
3424 Returns: nothing
3425 */
3426
3427 static void
3428 par_reduce(int max, BOOL fallback)
3429 {
3430 while (parcount > max)
3431 {
3432 address_item *doneaddr = par_wait();
3433 if (doneaddr == NULL)
3434 {
3435 log_write(0, LOG_MAIN|LOG_PANIC,
3436 "remote delivery process count got out of step");
3437 parcount = 0;
3438 }
3439 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3440 }
3441 }
3442
3443
3444
3445
3446 /*************************************************
3447 * Do remote deliveries *
3448 *************************************************/
3449
3450 /* This function is called to process the addresses in addr_remote. We must
3451 pick off the queue all addresses that have the same transport, remote
3452 destination, and errors address, and hand them to the transport in one go,
3453 subject to some configured limitations. If this is a run to continue delivering
3454 to an existing delivery channel, skip all but those addresses that can go to
3455 that channel. The skipped addresses just get deferred.
3456
3457 If mua_wrapper is set, all addresses must be able to be sent in a single
3458 transaction. If not, this function yields FALSE.
3459
3460 In Exim 4, remote deliveries are always done in separate processes, even
3461 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3462 is so that the base process can retain privilege. This makes the
3463 implementation of fallback transports feasible (though not initially done.)
3464
3465 We create up to the configured number of subprocesses, each of which passes
3466 back the delivery state via a pipe. (However, when sending down an existing
3467 connection, remote_max_parallel is forced to 1.)
3468
3469 Arguments:
3470 fallback TRUE if processing fallback hosts
3471
3472 Returns: TRUE normally
3473 FALSE if mua_wrapper is set and the addresses cannot all be sent
3474 in one transaction
3475 */
3476
3477 static BOOL
3478 do_remote_deliveries(BOOL fallback)
3479 {
3480 int parmax;
3481 int delivery_count;
3482 int poffset;
3483
3484 parcount = 0; /* Number of executing subprocesses */
3485
3486 /* When sending down an existing channel, only do one delivery at a time.
3487 We use a local variable (parmax) to hold the maximum number of processes;
3488 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3489
3490 if (continue_transport != NULL) remote_max_parallel = 1;
3491 parmax = remote_max_parallel;
3492
3493 /* If the data for keeping a list of processes hasn't yet been
3494 set up, do so. */
3495
3496 if (parlist == NULL)
3497 {
3498 parlist = store_get(remote_max_parallel * sizeof(pardata));
3499 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3500 parlist[poffset].pid = 0;
3501 }
3502
3503 /* Now loop for each remote delivery */
3504
3505 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3506 {
3507 pid_t pid;
3508 uid_t uid;
3509 gid_t gid;
3510 int pfd[2];
3511 int address_count = 1;
3512 int address_count_max;
3513 BOOL multi_domain;
3514 BOOL use_initgroups;
3515 BOOL pipe_done = FALSE;
3516 transport_instance *tp;
3517 address_item **anchor = &addr_remote;
3518 address_item *addr = addr_remote;
3519 address_item *last = addr;
3520 address_item *next;
3521
3522 /* Pull the first address right off the list. */
3523
3524 addr_remote = addr->next;
3525 addr->next = NULL;
3526
3527 DEBUG(D_deliver|D_transport)
3528 debug_printf("--------> %s <--------\n", addr->address);
3529
3530 /* If no transport has been set, there has been a big screw-up somewhere. */
3531
3532 if ((tp = addr->transport) == NULL)
3533 {
3534 disable_logging = FALSE; /* Jic */
3535 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3536 US"No transport set by router", fallback);
3537 continue;
3538 }
3539
3540 /* Check that this base address hasn't previously been delivered to this
3541 transport. The check is necessary at this point to handle homonymic addresses
3542 correctly in cases where the pattern of redirection changes between delivery
3543 attempts. Non-homonymic previous delivery is detected earlier, at routing
3544 time. */
3545
3546 if (previously_transported(addr, FALSE)) continue;
3547
3548 /* Force failure if the message is too big. */
3549
3550 if (tp->message_size_limit != NULL)
3551 {
3552 int rc = check_message_size(tp, addr);
3553 if (rc != OK)
3554 {
3555 addr->transport_return = rc;
3556 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3557 continue;
3558 }
3559 }
3560
3561 /* Get the flag which specifies whether the transport can handle different
3562 domains that nevertheless resolve to the same set of hosts. */
3563
3564 multi_domain = tp->multi_domain;
3565
3566 /* Get the maximum it can handle in one envelope, with zero meaning
3567 unlimited, which is forced for the MUA wrapper case. */
3568
3569 address_count_max = tp->max_addresses;
3570 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3571
3572
3573 /************************************************************************/
3574 /***** This is slightly experimental code, but should be safe. *****/
3575
3576 /* The address_count_max value is the maximum number of addresses that the
3577 transport can send in one envelope. However, the transport must be capable of
3578 dealing with any number of addresses. If the number it gets exceeds its
3579 envelope limitation, it must send multiple copies of the message. This can be
3580 done over a single connection for SMTP, so uses less resources than making
3581 multiple connections. On the other hand, if remote_max_parallel is greater
3582 than one, it is perhaps a good idea to use parallel processing to move the
3583 message faster, even if that results in multiple simultaneous connections to
3584 the same host.
3585
3586 How can we come to some compromise between these two ideals? What we do is to
3587 limit the number of addresses passed to a single instance of a transport to
3588 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3589 number of addresses routed to remote transports divided by
3590 remote_max_parallel. For example, if the message has 100 remote recipients,
3591 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3592 once. But if rcpt_max is 100, we could send up to 100.
3593
3594 Of course, not all the remotely addresses in a message are going to go to the
3595 same set of hosts (except in smarthost configurations), so this is just a
3596 heuristic way of dividing up the work.
3597
3598 Furthermore (1), because this may not be wanted in some cases, and also to
3599 cope with really pathological cases, there is also a limit to the number of
3600 messages that are sent over one connection. This is the same limit that is
3601 used when sending several different messages over the same connection.
3602 Continue_sequence is set when in this situation, to the number sent so
3603 far, including this message.
3604
3605 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3606 is probably because they are using VERP, in which case they want to pass only
3607 one address at a time to the transport, in order to be able to use
3608 $local_part and $domain in constructing a new return path. We could test for
3609 the use of these variables, but as it is so likely they will be used when the
3610 maximum is 1, we don't bother. Just leave the value alone. */
3611
3612 if (address_count_max != 1 &&
3613 address_count_max < remote_delivery_count/remote_max_parallel)
3614 {
3615 int new_max = remote_delivery_count/remote_max_parallel;
3616 int message_max = tp->connection_max_messages;
3617 if (connection_max_messages >= 0) message_max = connection_max_messages;
3618 message_max -= continue_sequence - 1;
3619 if (message_max > 0 && new_max > address_count_max * message_max)
3620 new_max = address_count_max * message_max;
3621 address_count_max = new_max;
3622 }
3623
3624 /************************************************************************/
3625
3626
3627 /* Pick off all addresses which have the same transport, errors address,
3628 destination, and extra headers. In some cases they point to the same host
3629 list, but we also need to check for identical host lists generated from
3630 entirely different domains. The host list pointers can be NULL in the case
3631 where the hosts are defined in the transport. There is also a configured
3632 maximum limit of addresses that can be handled at once (see comments above
3633 for how it is computed). */
3634
3635 while ((next = *anchor) != NULL && address_count < address_count_max)
3636 {
3637 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3638 &&
3639 tp == next->transport
3640 &&
3641 same_hosts(next->host_list, addr->host_list)
3642 &&
3643 same_strings(next->p.errors_address, addr->p.errors_address)
3644 &&
3645 same_headers(next->p.extra_headers, addr->p.extra_headers)
3646 &&
3647 same_ugid(tp, next, addr)
3648 &&
3649 (next->p.remove_headers == addr->p.remove_headers ||
3650 (next->p.remove_headers != NULL &&
3651 addr->p.remove_headers != NULL &&
3652 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3653 {
3654 *anchor = next->next;
3655 next->next = NULL;
3656 next->first = addr; /* remember top one (for retry processing) */
3657 last->next = next;
3658 last = next;
3659 address_count++;
3660 }
3661 else anchor = &(next->next);
3662 }
3663
3664 /* If we are acting as an MUA wrapper, all addresses must go in a single
3665 transaction. If not, put them back on the chain and yield FALSE. */
3666
3667 if (mua_wrapper && addr_remote != NULL)
3668 {
3669 last->next = addr_remote;
3670 addr_remote = addr;
3671 return FALSE;
3672 }
3673
3674 /* Set up the expansion variables for this set of addresses */
3675
3676 deliver_set_expansions(addr);
3677
3678 /* Compute the return path, expanding a new one if required. The old one
3679 must be set first, as it might be referred to in the expansion. */
3680
3681 if(addr->p.errors_address != NULL)
3682 return_path = addr->p.errors_address;
3683 #ifdef EXPERIMENTAL_SRS
3684 else if(addr->p.srs_sender != NULL)
3685 return_path = addr->p.srs_sender;
3686 #endif
3687 else
3688 return_path = sender_address;
3689
3690 if (tp->return_path != NULL)
3691 {
3692 uschar *new_return_path = expand_string(tp->return_path);
3693 if (new_return_path == NULL)
3694 {
3695 if (!expand_string_forcedfail)
3696 {
3697 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3698 string_sprintf("Failed to expand return path \"%s\": %s",
3699 tp->return_path, expand_string_message), fallback);
3700 continue;
3701 }
3702 }
3703 else return_path = new_return_path;
3704 }
3705
3706 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3707 logs and sets up error messages, so we just post-process and continue with
3708 the next address. */
3709
3710 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3711 {
3712 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3713 continue;
3714 }
3715
3716 /* If this transport has a setup function, call it now so that it gets
3717 run in this process and not in any subprocess. That way, the results of
3718 any setup that are retained by the transport can be reusable. One of the
3719 things the setup does is to set the fallback host lists in the addresses.
3720 That is why it is called at this point, before the continue delivery
3721 processing, because that might use the fallback hosts. */
3722
3723 if (tp->setup != NULL)
3724 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3725
3726 /* If this is a run to continue delivery down an already-established
3727 channel, check that this set of addresses matches the transport and
3728 the channel. If it does not, defer the addresses. If a host list exists,
3729 we must check that the continue host is on the list. Otherwise, the
3730 host is set in the transport. */
3731
3732 continue_more = FALSE; /* In case got set for the last lot */
3733 if (continue_transport != NULL)
3734 {
3735 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3736 if (ok && addr->host_list != NULL)
3737 {
3738 host_item *h;
3739 ok = FALSE;
3740 for (h = addr->host_list; h != NULL; h = h->next)
3741 {
3742 if (Ustrcmp(h->name, continue_hostname) == 0)
3743 { ok = TRUE; break; }
3744 }
3745 }
3746
3747 /* Addresses not suitable; defer or queue for fallback hosts (which
3748 might be the continue host) and skip to next address. */
3749
3750 if (!ok)
3751 {
3752 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3753 next = addr;
3754
3755 if (addr->fallback_hosts != NULL && !fallback)
3756 {
3757 for (;;)
3758 {
3759 next->host_list = next->fallback_hosts;
3760 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3761 if (next->next == NULL) break;
3762 next = next->next;
3763 }
3764 next->next = addr_fallback;
3765 addr_fallback = addr;
3766 }
3767
3768 else
3769 {
3770 while (next->next != NULL) next = next->next;
3771 next->next = addr_defer;
3772 addr_defer = addr;
3773 }
3774
3775 continue;
3776 }
3777
3778 /* Set a flag indicating whether there are further addresses that list
3779 the continued host. This tells the transport to leave the channel open,
3780 but not to pass it to another delivery process. */
3781
3782 for (next = addr_remote; next != NULL; next = next->next)
3783 {
3784 host_item *h;
3785 for (h = next->host_list; h != NULL; h = h->next)
3786 {
3787 if (Ustrcmp(h->name, continue_hostname) == 0)
3788 { continue_more = TRUE; break; }
3789 }
3790 }
3791 }
3792
3793 /* The transports set up the process info themselves as they may connect
3794 to more than one remote machine. They also have to set up the filter
3795 arguments, if required, so that the host name and address are available
3796 for expansion. */
3797
3798 transport_filter_argv = NULL;
3799
3800 /* Create the pipe for inter-process communication. If pipe creation
3801 fails, it is probably because the value of remote_max_parallel is so
3802 large that too many file descriptors for pipes have been created. Arrange
3803 to wait for a process to finish, and then try again. If we still can't
3804 create a pipe when all processes have finished, break the retry loop. */
3805
3806 while (!pipe_done)
3807 {
3808 if (pipe(pfd) == 0) pipe_done = TRUE;
3809 else if (parcount > 0) parmax = parcount;
3810 else break;
3811
3812 /* We need to make the reading end of the pipe non-blocking. There are
3813 two different options for this. Exim is cunningly (I hope!) coded so
3814 that it can use either of them, though it prefers O_NONBLOCK, which
3815 distinguishes between EOF and no-more-data. */
3816
3817 #ifdef O_NONBLOCK
3818 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3819 #else
3820 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3821 #endif
3822
3823 /* If the maximum number of subprocesses already exist, wait for a process
3824 to finish. If we ran out of file descriptors, parmax will have been reduced
3825 from its initial value of remote_max_parallel. */
3826
3827 par_reduce(parmax - 1, fallback);
3828 }
3829
3830 /* If we failed to create a pipe and there were no processes to wait
3831 for, we have to give up on this one. Do this outside the above loop
3832 so that we can continue the main loop. */
3833
3834 if (!pipe_done)
3835 {
3836 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3837 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3838 continue;
3839 }
3840
3841 /* Find a free slot in the pardata list. Must do this after the possible
3842 waiting for processes to finish, because a terminating process will free
3843 up a slot. */
3844
3845 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3846 if (parlist[poffset].pid == 0) break;
3847
3848 /* If there isn't one, there has been a horrible disaster. */
3849
3850 if (poffset >= remote_max_parallel)
3851 {
3852 (void)close(pfd[pipe_write]);
3853 (void)close(pfd[pipe_read]);
3854 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3855 US"Unexpectedly no free subprocess slot", fallback);
3856 continue;
3857 }
3858
3859 /* Now fork a subprocess to do the remote delivery, but before doing so,
3860 ensure that any cached resourses are released so as not to interfere with
3861 what happens in the subprocess. */
3862
3863 search_tidyup();
3864
3865 if ((pid = fork()) == 0)
3866 {
3867 int fd = pfd[pipe_write];
3868 host_item *h;
3869
3870 /* There are weird circumstances in which logging is disabled */
3871
3872 disable_logging = tp->disable_logging;
3873
3874 /* Show pids on debug output if parallelism possible */
3875
3876 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3877 {
3878 DEBUG(D_any|D_v) debug_selector |= D_pid;
3879 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3880 }
3881
3882 /* Reset the random number generator, so different processes don't all
3883 have the same sequence. In the test harness we want different, but
3884 predictable settings for each delivery process, so do something explicit
3885 here rather they rely on the fixed reset in the random number function. */
3886
3887 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3888
3889 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3890 a new process that may be forked to do another delivery down the same
3891 SMTP connection. */
3892
3893 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
3894
3895 /* Close open file descriptors for the pipes of other processes
3896 that are running in parallel. */
3897
3898 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3899 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
3900
3901 /* This process has inherited a copy of the file descriptor
3902 for the data file, but its file pointer is shared with all the
3903 other processes running in parallel. Therefore, we have to re-open
3904 the file in order to get a new file descriptor with its own
3905 file pointer. We don't need to lock it, as the lock is held by
3906 the parent process. There doesn't seem to be any way of doing
3907 a dup-with-new-file-pointer. */
3908
3909 (void)close(deliver_datafile);
3910 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3911 message_id);
3912 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3913
3914 if (deliver_datafile < 0)
3915 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3916 "parallel delivery: %s", spoolname, strerror(errno));
3917
3918 /* Set the close-on-exec flag */
3919
3920 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
3921 FD_CLOEXEC);
3922
3923 /* Set the uid/gid of this process; bombs out on failure. */
3924
3925 exim_setugid(uid, gid, use_initgroups,
3926 string_sprintf("remote delivery to %s with transport=%s",
3927 addr->address, tp->name));
3928
3929 /* Close the unwanted half of this process' pipe, set the process state,
3930 and run the transport. Afterwards, transport_count will contain the number
3931 of bytes written. */
3932
3933 (void)close(pfd[pipe_read]);
3934 set_process_info("delivering %s using %s", message_id, tp->name);
3935 debug_print_string(tp->debug_string);
3936 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3937
3938 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3939 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3940
3941 /* Ensure any cached resources that we used are now released */
3942
3943 search_tidyup();
3944
3945 /* Pass the result back down the pipe. This is a lot more information
3946 than is needed for a local delivery. We have to send back the error
3947 status for each address, the usability status for each host that is
3948 flagged as unusable, and all the retry items. When TLS is in use, we
3949 send also the cipher and peerdn information. Each type of information
3950 is flagged by an identifying byte, and is then in a fixed format (with
3951 strings terminated by zeros), and there is a final terminator at the
3952 end. The host information and retry information is all attached to
3953 the first address, so that gets sent at the start. */
3954
3955 /* Host unusability information: for most success cases this will
3956 be null. */
3957
3958 for (h = addr->host_list; h != NULL; h = h->next)
3959 {
3960 if (h->address == NULL || h->status < hstatus_unusable) continue;
3961 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
3962 (void)write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
3963 }
3964
3965 /* The number of bytes written. This is the same for each address. Even
3966 if we sent several copies of the message down the same connection, the
3967 size of each one is the same, and it's that value we have got because
3968 transport_count gets reset before calling transport_write_message(). */
3969
3970 big_buffer[0] = 'S';
3971 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
3972 (void)write(fd, big_buffer, sizeof(transport_count) + 1);
3973
3974 /* Information about what happened to each address. Four item types are
3975 used: an optional 'X' item first, for TLS information, then an optional "C"
3976 item for any client-auth info followed by 'R' items for any retry settings,
3977 and finally an 'A' item for the remaining data. */
3978
3979 for(; addr != NULL; addr = addr->next)
3980 {
3981 uschar *ptr;
3982 retry_item *r;
3983
3984 /* The certificate verification status goes into the flags */
3985
3986 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
3987
3988 /* Use an X item only if there's something to send */
3989
3990 #ifdef SUPPORT_TLS
3991 if (addr->cipher != NULL)
3992 {
3993 ptr = big_buffer;
3994 sprintf(CS ptr, "X%.128s", addr->cipher);
3995 while(*ptr++);
3996 if (addr->peerdn == NULL) *ptr++ = 0; else
3997 {
3998 sprintf(CS ptr, "%.512s", addr->peerdn);
3999 while(*ptr++);
4000 }
4001 (void)write(fd, big_buffer, ptr - big_buffer);
4002 }
4003 #endif
4004
4005 if (client_authenticator)
4006 {
4007 ptr = big_buffer;
4008 sprintf(CS big_buffer, "C1%.64s", client_authenticator);
4009 while(*ptr++);
4010 (void)write(fd, big_buffer, ptr - big_buffer);
4011 }
4012 if (client_auth