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