Remove details of errors in bounce and delay warning messages, unless
[exim.git] / src / src / deliver.c
1 /* $Cambridge: exim/src/src/deliver.c,v 1.14 2005/04/28 13:06:32 ph10 Exp $ */
2
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
6
7 /* Copyright (c) University of Cambridge 1995 - 2005 */
8 /* See the file NOTICE for conditions of use and distribution. */
9
10 /* The main code for delivering a message. */
11
12
13 #include "exim.h"
14
15
16 /* Data block for keeping track of subprocesses for parallel remote
17 delivery. */
18
19 typedef struct pardata {
20 address_item *addrlist; /* chain of addresses */
21 address_item *addr; /* next address data expected for */
22 pid_t pid; /* subprocess pid */
23 int fd; /* pipe fd for getting result from subprocess */
24 int transport_count; /* returned transport count value */
25 BOOL done; /* no more data needed */
26 uschar *msg; /* error message */
27 uschar *return_path; /* return_path for these addresses */
28 } pardata;
29
30 /* Values for the process_recipients variable */
31
32 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
33 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
34 RECIP_FAIL_LOOP};
35
36 /* Mutually recursive functions for marking addresses done. */
37
38 static void child_done(address_item *, uschar *);
39 static void address_done(address_item *, uschar *);
40
41 /* Table for turning base-62 numbers into binary */
42
43 static uschar tab62[] =
44 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
45 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
46 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
47 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
48 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
49 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
50 59,60,61}; /* x-z */
51
52
53 /*************************************************
54 * Local static variables *
55 *************************************************/
56
57 /* addr_duplicate is global because it needs to be seen from the Envelope-To
58 writing code. */
59
60 static address_item *addr_defer = NULL;
61 static address_item *addr_failed = NULL;
62 static address_item *addr_fallback = NULL;
63 static address_item *addr_local = NULL;
64 static address_item *addr_new = NULL;
65 static address_item *addr_remote = NULL;
66 static address_item *addr_route = NULL;
67 static address_item *addr_succeed = NULL;
68
69 static FILE *message_log = NULL;
70 static BOOL update_spool;
71 static BOOL remove_journal;
72 static int parcount = 0;
73 static pardata *parlist = NULL;
74 static int return_count;
75 static uschar *frozen_info = US"";
76 static uschar *used_return_path = NULL;
77
78 static uschar spoolname[PATH_MAX];
79
80
81
82 /*************************************************
83 * Make a new address item *
84 *************************************************/
85
86 /* This function gets the store and initializes with default values. The
87 transport_return value defaults to DEFER, so that any unexpected failure to
88 deliver does not wipe out the message. The default unique string is set to a
89 copy of the address, so that its domain can be lowercased.
90
91 Argument:
92 address the RFC822 address string
93 copy force a copy of the address
94
95 Returns: a pointer to an initialized address_item
96 */
97
98 address_item *
99 deliver_make_addr(uschar *address, BOOL copy)
100 {
101 address_item *addr = store_get(sizeof(address_item));
102 *addr = address_defaults;
103 if (copy) address = string_copy(address);
104 addr->address = address;
105 addr->unique = string_copy(address);
106 return addr;
107 }
108
109
110
111
112 /*************************************************
113 * Set expansion values for an address *
114 *************************************************/
115
116 /* Certain expansion variables are valid only when handling an address or
117 address list. This function sets them up or clears the values, according to its
118 argument.
119
120 Arguments:
121 addr the address in question, or NULL to clear values
122 Returns: nothing
123 */
124
125 void
126 deliver_set_expansions(address_item *addr)
127 {
128 if (addr == NULL)
129 {
130 uschar ***p = address_expansions;
131 while (*p != NULL) **p++ = NULL;
132 return;
133 }
134
135 /* Exactly what gets set depends on whether there is one or more addresses, and
136 what they contain. These first ones are always set, taking their values from
137 the first address. */
138
139 if (addr->host_list == NULL)
140 {
141 deliver_host = deliver_host_address = US"";
142 }
143 else
144 {
145 deliver_host = addr->host_list->name;
146 deliver_host_address = addr->host_list->address;
147 }
148
149 deliver_recipients = addr;
150 deliver_address_data = addr->p.address_data;
151 deliver_domain_data = addr->p.domain_data;
152 deliver_localpart_data = addr->p.localpart_data;
153
154 /* These may be unset for multiple addresses */
155
156 deliver_domain = addr->domain;
157 self_hostname = addr->self_hostname;
158
159 #ifdef EXPERIMENTAL_BRIGHTMAIL
160 bmi_deliver = 1; /* deliver by default */
161 bmi_alt_location = NULL;
162 bmi_base64_verdict = NULL;
163 bmi_base64_tracker_verdict = NULL;
164 #endif
165
166 /* If there's only one address we can set everything. */
167
168 if (addr->next == NULL)
169 {
170 address_item *addr_orig;
171
172 deliver_localpart = addr->local_part;
173 deliver_localpart_prefix = addr->prefix;
174 deliver_localpart_suffix = addr->suffix;
175
176 for (addr_orig = addr; addr_orig->parent != NULL;
177 addr_orig = addr_orig->parent);
178 deliver_domain_orig = addr_orig->domain;
179
180 /* Re-instate any prefix and suffix in the original local part. In all
181 normal cases, the address will have a router associated with it, and we can
182 choose the caseful or caseless version accordingly. However, when a system
183 filter sets up a pipe, file, or autoreply delivery, no router is involved.
184 In this case, though, there won't be any prefix or suffix to worry about. */
185
186 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
187 addr_orig->router->caseful_local_part?
188 addr_orig->cc_local_part : addr_orig->lc_local_part;
189
190 /* If there's a parent, make its domain and local part available, and if
191 delivering to a pipe or file, or sending an autoreply, get the local
192 part from the parent. For pipes and files, put the pipe or file string
193 into address_pipe and address_file. */
194
195 if (addr->parent != NULL)
196 {
197 deliver_domain_parent = addr->parent->domain;
198 deliver_localpart_parent = (addr->parent->router == NULL)?
199 addr->parent->local_part :
200 addr->parent->router->caseful_local_part?
201 addr->parent->cc_local_part : addr->parent->lc_local_part;
202
203 /* File deliveries have their own flag because they need to be picked out
204 as special more often. */
205
206 if (testflag(addr, af_pfr))
207 {
208 if (testflag(addr, af_file)) address_file = addr->local_part;
209 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
210 deliver_localpart = addr->parent->local_part;
211 deliver_localpart_prefix = addr->parent->prefix;
212 deliver_localpart_suffix = addr->parent->suffix;
213 }
214 }
215
216 #ifdef EXPERIMENTAL_BRIGHTMAIL
217 /* Set expansion variables related to Brightmail AntiSpam */
218 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
219 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
220 /* get message delivery status (0 - don't deliver | 1 - deliver) */
221 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
222 /* if message is to be delivered, get eventual alternate location */
223 if (bmi_deliver == 1) {
224 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
225 };
226 #endif
227
228 }
229
230 /* For multiple addresses, don't set local part, and leave the domain and
231 self_hostname set only if it is the same for all of them. */
232
233 else
234 {
235 address_item *addr2;
236 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
237 {
238 if (deliver_domain != NULL &&
239 Ustrcmp(deliver_domain, addr2->domain) != 0)
240 deliver_domain = NULL;
241 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
242 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
243 self_hostname = NULL;
244 if (deliver_domain == NULL && self_hostname == NULL) break;
245 }
246 }
247 }
248
249
250
251
252 /*************************************************
253 * Open a msglog file *
254 *************************************************/
255
256 /* This function is used both for normal message logs, and for files in the
257 msglog directory that are used to catch output from pipes. Try to create the
258 directory if it does not exist. From release 4.21, normal message logs should
259 be created when the message is received.
260
261 Argument:
262 filename the file name
263 mode the mode required
264 error used for saying what failed
265
266 Returns: a file descriptor, or -1 (with errno set)
267 */
268
269 static int
270 open_msglog_file(uschar *filename, int mode, uschar **error)
271 {
272 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
273
274 if (fd < 0 && errno == ENOENT)
275 {
276 uschar temp[16];
277 sprintf(CS temp, "msglog/%s", message_subdir);
278 if (message_subdir[0] == 0) temp[6] = 0;
279 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
280 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
281 }
282
283 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
284 function is called as root). Double check the mode, because the group setting
285 doesn't always get set automatically. */
286
287 if (fd >= 0)
288 {
289 fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
290 if (fchown(fd, exim_uid, exim_gid) < 0)
291 {
292 *error = US"chown";
293 return -1;
294 }
295 if (fchmod(fd, mode) < 0)
296 {
297 *error = US"chmod";
298 return -1;
299 }
300 }
301 else *error = US"create";
302
303 return fd;
304 }
305
306
307
308
309 /*************************************************
310 * Write to msglog if required *
311 *************************************************/
312
313 /* Write to the message log, if configured. This function may also be called
314 from transports.
315
316 Arguments:
317 format a string format
318
319 Returns: nothing
320 */
321
322 void
323 deliver_msglog(const char *format, ...)
324 {
325 va_list ap;
326 if (!message_logs) return;
327 va_start(ap, format);
328 vfprintf(message_log, format, ap);
329 fflush(message_log);
330 va_end(ap);
331 }
332
333
334
335
336 /*************************************************
337 * Replicate status for batch *
338 *************************************************/
339
340 /* When a transport handles a batch of addresses, it may treat them
341 individually, or it may just put the status in the first one, and return FALSE,
342 requesting that the status be copied to all the others externally. This is the
343 replication function. As well as the status, it copies the transport pointer,
344 which may have changed if appendfile passed the addresses on to a different
345 transport.
346
347 Argument: pointer to the first address in a chain
348 Returns: nothing
349 */
350
351 static void
352 replicate_status(address_item *addr)
353 {
354 address_item *addr2;
355 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
356 {
357 addr2->transport = addr->transport;
358 addr2->transport_return = addr->transport_return;
359 addr2->basic_errno = addr->basic_errno;
360 addr2->more_errno = addr->more_errno;
361 addr2->special_action = addr->special_action;
362 addr2->message = addr->message;
363 addr2->user_message = addr->user_message;
364 }
365 }
366
367
368
369 /*************************************************
370 * Compare lists of hosts *
371 *************************************************/
372
373 /* This function is given two pointers to chains of host items, and it yields
374 TRUE if the lists refer to the same hosts in the same order, except that
375
376 (1) Multiple hosts with the same non-negative MX values are permitted to appear
377 in different orders. Round-robinning nameservers can cause this to happen.
378
379 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
380 permitted to appear in different orders. This is caused by randomizing
381 hosts lists.
382
383 This enables Exim to use a single SMTP transaction for sending to two entirely
384 different domains that happen to end up pointing at the same hosts.
385
386 Arguments:
387 one points to the first host list
388 two points to the second host list
389
390 Returns: TRUE if the lists refer to the same host set
391 */
392
393 static BOOL
394 same_hosts(host_item *one, host_item *two)
395 {
396 while (one != NULL && two != NULL)
397 {
398 if (Ustrcmp(one->name, two->name) != 0)
399 {
400 int mx = one->mx;
401 host_item *end_one = one;
402 host_item *end_two = two;
403
404 /* Batch up only if there was no MX and the list was not randomized */
405
406 if (mx == MX_NONE) return FALSE;
407
408 /* Find the ends of the shortest sequence of identical MX values */
409
410 while (end_one->next != NULL && end_one->next->mx == mx &&
411 end_two->next != NULL && end_two->next->mx == mx)
412 {
413 end_one = end_one->next;
414 end_two = end_two->next;
415 }
416
417 /* If there aren't any duplicates, there's no match. */
418
419 if (end_one == one) return FALSE;
420
421 /* For each host in the 'one' sequence, check that it appears in the 'two'
422 sequence, returning FALSE if not. */
423
424 for (;;)
425 {
426 host_item *hi;
427 for (hi = two; hi != end_two->next; hi = hi->next)
428 if (Ustrcmp(one->name, hi->name) == 0) break;
429 if (hi == end_two->next) return FALSE;
430 if (one == end_one) break;
431 one = one->next;
432 }
433
434 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
435 Ensure both are pointing at the last host, and carry on as for equality. */
436
437 two = end_two;
438 }
439
440 /* Hosts matched */
441
442 one = one->next;
443 two = two->next;
444 }
445
446 /* True if both are NULL */
447
448 return (one == two);
449 }
450
451
452
453 /*************************************************
454 * Compare header lines *
455 *************************************************/
456
457 /* This function is given two pointers to chains of header items, and it yields
458 TRUE if they are the same header texts in the same order.
459
460 Arguments:
461 one points to the first header list
462 two points to the second header list
463
464 Returns: TRUE if the lists refer to the same header set
465 */
466
467 static BOOL
468 same_headers(header_line *one, header_line *two)
469 {
470 for (;;)
471 {
472 if (one == two) return TRUE; /* Includes the case where both NULL */
473 if (one == NULL || two == NULL) return FALSE;
474 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
475 one = one->next;
476 two = two->next;
477 }
478 }
479
480
481
482 /*************************************************
483 * Compare string settings *
484 *************************************************/
485
486 /* This function is given two pointers to strings, and it returns
487 TRUE if they are the same pointer, or if the two strings are the same.
488
489 Arguments:
490 one points to the first string
491 two points to the second string
492
493 Returns: TRUE or FALSE
494 */
495
496 static BOOL
497 same_strings(uschar *one, uschar *two)
498 {
499 if (one == two) return TRUE; /* Includes the case where both NULL */
500 if (one == NULL || two == NULL) return FALSE;
501 return (Ustrcmp(one, two) == 0);
502 }
503
504
505
506 /*************************************************
507 * Compare uid/gid for addresses *
508 *************************************************/
509
510 /* This function is given a transport and two addresses. It yields TRUE if the
511 uid/gid/initgroups settings for the two addresses are going to be the same when
512 they are delivered.
513
514 Arguments:
515 tp the transort
516 addr1 the first address
517 addr2 the second address
518
519 Returns: TRUE or FALSE
520 */
521
522 static BOOL
523 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
524 {
525 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
526 {
527 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
528 (testflag(addr1, af_uid_set) &&
529 (addr1->uid != addr2->uid ||
530 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
531 return FALSE;
532 }
533
534 if (!tp->gid_set && tp->expand_gid == NULL)
535 {
536 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
537 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
538 return FALSE;
539 }
540
541 return TRUE;
542 }
543
544
545
546
547 /*************************************************
548 * Record that an address is complete *
549 *************************************************/
550
551 /* This function records that an address is complete. This is straightforward
552 for most addresses, where the unique address is just the full address with the
553 domain lower cased. For homonyms (addresses that are the same as one of their
554 ancestors) their are complications. Their unique addresses have \x\ prepended
555 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
556 cousins.
557
558 Exim used to record the unique addresses of homonyms as "complete". This,
559 however, fails when the pattern of redirection varies over time (e.g. if taking
560 unseen copies at only some times of day) because the prepended numbers may vary
561 from one delivery run to the next. This problem is solved by never recording
562 prepended unique addresses as complete. Instead, when a homonymic address has
563 actually been delivered via a transport, we record its basic unique address
564 followed by the name of the transport. This is checked in subsequent delivery
565 runs whenever an address is routed to a transport.
566
567 If the completed address is a top-level one (has no parent, which means it
568 cannot be homonymic) we also add the original address to the non-recipients
569 tree, so that it gets recorded in the spool file and therefore appears as
570 "done" in any spool listings. The original address may differ from the unique
571 address in the case of the domain.
572
573 Finally, this function scans the list of duplicates, marks as done any that
574 match this address, and calls child_done() for their ancestors.
575
576 Arguments:
577 addr address item that has been completed
578 now current time as a string
579
580 Returns: nothing
581 */
582
583 static void
584 address_done(address_item *addr, uschar *now)
585 {
586 address_item *dup;
587
588 update_spool = TRUE; /* Ensure spool gets updated */
589
590 /* Top-level address */
591
592 if (addr->parent == NULL)
593 {
594 tree_add_nonrecipient(addr->unique);
595 tree_add_nonrecipient(addr->address);
596 }
597
598 /* Homonymous child address */
599
600 else if (testflag(addr, af_homonym))
601 {
602 if (addr->transport != NULL)
603 {
604 tree_add_nonrecipient(
605 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
606 }
607 }
608
609 /* Non-homonymous child address */
610
611 else tree_add_nonrecipient(addr->unique);
612
613 /* Check the list of duplicate addresses and ensure they are now marked
614 done as well. */
615
616 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
617 {
618 if (Ustrcmp(addr->unique, dup->unique) == 0)
619 {
620 tree_add_nonrecipient(dup->address);
621 child_done(dup, now);
622 }
623 }
624 }
625
626
627
628
629 /*************************************************
630 * Decrease counts in parents and mark done *
631 *************************************************/
632
633 /* This function is called when an address is complete. If there is a parent
634 address, its count of children is decremented. If there are still other
635 children outstanding, the function exits. Otherwise, if the count has become
636 zero, address_done() is called to mark the parent and its duplicates complete.
637 Then loop for any earlier ancestors.
638
639 Arguments:
640 addr points to the completed address item
641 now the current time as a string, for writing to the message log
642
643 Returns: nothing
644 */
645
646 static void
647 child_done(address_item *addr, uschar *now)
648 {
649 address_item *aa;
650 while (addr->parent != NULL)
651 {
652 addr = addr->parent;
653 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
654 address_done(addr, now);
655
656 /* Log the completion of all descendents only when there is no ancestor with
657 the same original address. */
658
659 for (aa = addr->parent; aa != NULL; aa = aa->parent)
660 if (Ustrcmp(aa->address, addr->address) == 0) break;
661 if (aa != NULL) continue;
662
663 deliver_msglog("%s %s: children all complete\n", now, addr->address);
664 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
665 }
666 }
667
668
669
670
671 /*************************************************
672 * Actions at the end of handling an address *
673 *************************************************/
674
675 /* This is a function for processing a single address when all that can be done
676 with it has been done.
677
678 Arguments:
679 addr points to the address block
680 result the result of the delivery attempt
681 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
682 driver_type indicates which type of driver (transport, or router) was last
683 to process the address
684 logchar '=' or '-' for use when logging deliveries with => or ->
685
686 Returns: nothing
687 */
688
689 static void
690 post_process_one(address_item *addr, int result, int logflags, int driver_type,
691 int logchar)
692 {
693 uschar *now = tod_stamp(tod_log);
694 uschar *driver_kind = NULL;
695 uschar *driver_name = NULL;
696 uschar *log_address;
697
698 int size = 256; /* Used for a temporary, */
699 int ptr = 0; /* expanding buffer, for */
700 uschar *s; /* building log lines; */
701 void *reset_point; /* released afterwards. */
702
703
704 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
705
706 /* Set up driver kind and name for logging. Disable logging if the router or
707 transport has disabled it. */
708
709 if (driver_type == DTYPE_TRANSPORT)
710 {
711 if (addr->transport != NULL)
712 {
713 driver_name = addr->transport->name;
714 driver_kind = US" transport";
715 disable_logging = addr->transport->disable_logging;
716 }
717 else driver_kind = US"transporting";
718 }
719 else if (driver_type == DTYPE_ROUTER)
720 {
721 if (addr->router != NULL)
722 {
723 driver_name = addr->router->name;
724 driver_kind = US" router";
725 disable_logging = addr->router->disable_logging;
726 }
727 else driver_kind = US"routing";
728 }
729
730 /* If there's an error message set, ensure that it contains only printing
731 characters - it should, but occasionally things slip in and this at least
732 stops the log format from getting wrecked. We also scan the message for an LDAP
733 expansion item that has a password setting, and flatten the password. This is a
734 fudge, but I don't know a cleaner way of doing this. (If the item is badly
735 malformed, it won't ever have gone near LDAP.) */
736
737 if (addr->message != NULL)
738 {
739 addr->message = string_printing(addr->message);
740 if (Ustrstr(addr->message, "failed to expand") != NULL &&
741 (Ustrstr(addr->message, "ldap:") != NULL ||
742 Ustrstr(addr->message, "ldapdn:") != NULL ||
743 Ustrstr(addr->message, "ldapm:") != NULL))
744 {
745 uschar *p = Ustrstr(addr->message, "pass=");
746 if (p != NULL)
747 {
748 p += 5;
749 while (*p != 0 && !isspace(*p)) *p++ = 'x';
750 }
751 }
752 }
753
754 /* If we used a transport that has one of the "return_output" options set, and
755 if it did in fact generate some output, then for return_output we treat the
756 message as failed if it was not already set that way, so that the output gets
757 returned to the sender, provided there is a sender to send it to. For
758 return_fail_output, do this only if the delivery failed. Otherwise we just
759 unlink the file, and remove the name so that if the delivery failed, we don't
760 try to send back an empty or unwanted file. The log_output options operate only
761 on a non-empty file.
762
763 In any case, we close the message file, because we cannot afford to leave a
764 file-descriptor for one address while processing (maybe very many) others. */
765
766 if (addr->return_file >= 0 && addr->return_filename != NULL)
767 {
768 BOOL return_output = FALSE;
769 struct stat statbuf;
770 fsync(addr->return_file);
771
772 /* If there is no output, do nothing. */
773
774 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
775 {
776 transport_instance *tb = addr->transport;
777
778 /* Handle logging options */
779
780 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
781 (result == DEFER && tb->log_defer_output))
782 {
783 uschar *s;
784 FILE *f = Ufopen(addr->return_filename, "rb");
785 if (f == NULL)
786 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
787 "from %s transport: %s", addr->return_filename, tb->name,
788 strerror(errno));
789 else
790 {
791 s = US Ufgets(big_buffer, big_buffer_size, f);
792 if (s != NULL)
793 {
794 uschar *p = big_buffer + Ustrlen(big_buffer);
795 while (p > big_buffer && isspace(p[-1])) p--;
796 *p = 0;
797 s = string_printing(big_buffer);
798 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
799 addr->address, tb->name, s);
800 }
801 fclose(f);
802 }
803 }
804
805 /* Handle returning options, but only if there is an address to return
806 the text to. */
807
808 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
809 {
810 if (tb->return_output)
811 {
812 addr->transport_return = result = FAIL;
813 if (addr->basic_errno == 0 && addr->message == NULL)
814 addr->message = US"return message generated";
815 return_output = TRUE;
816 }
817 else
818 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
819 }
820 }
821
822 /* Get rid of the file unless it might be returned, but close it in
823 all cases. */
824
825 if (!return_output)
826 {
827 Uunlink(addr->return_filename);
828 addr->return_filename = NULL;
829 addr->return_file = -1;
830 }
831
832 close(addr->return_file);
833 }
834
835 /* Create the address string for logging. Must not do this earlier, because
836 an OK result may be changed to FAIL when a pipe returns text. */
837
838 log_address = string_log_address(addr,
839 (log_write_selector & L_all_parents) != 0, result == OK);
840
841 /* The sucess case happens only after delivery by a transport. */
842
843 if (result == OK)
844 {
845 addr->next = addr_succeed;
846 addr_succeed = addr;
847
848 /* Call address_done() to ensure that we don't deliver to this address again,
849 and write appropriate things to the message log. If it is a child address, we
850 call child_done() to scan the ancestors and mark them complete if this is the
851 last child to complete. */
852
853 address_done(addr, now);
854 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
855
856 if (addr->parent == NULL)
857 {
858 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
859 driver_name, driver_kind);
860 }
861 else
862 {
863 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
864 addr->parent->address, driver_name, driver_kind);
865 child_done(addr, now);
866 }
867
868 /* Log the delivery on the main log. We use an extensible string to build up
869 the log line, and reset the store afterwards. Remote deliveries should always
870 have a pointer to the host item that succeeded; local deliveries can have a
871 pointer to a single host item in their host list, for use by the transport. */
872
873 s = reset_point = store_get(size);
874 s[ptr++] = logchar;
875
876 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
877
878 if ((log_extra_selector & LX_sender_on_delivery) != 0)
879 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
880
881 /* You might think that the return path must always be set for a successful
882 delivery; indeed, I did for some time, until this statement crashed. The case
883 when it is not set is for a delivery to /dev/null which is optimised by not
884 being run at all. */
885
886 if (used_return_path != NULL &&
887 (log_extra_selector & LX_return_path_on_delivery) != 0)
888 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
889
890 /* For a delivery from a system filter, there may not be a router */
891
892 if (addr->router != NULL)
893 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
894
895 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
896
897 if ((log_extra_selector & LX_delivery_size) != 0)
898 s = string_append(s, &size, &ptr, 2, US" S=",
899 string_sprintf("%d", transport_count));
900
901 /* Local delivery */
902
903 if (addr->transport->info->local)
904 {
905 if (addr->host_list != NULL)
906 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
907 if (addr->shadow_message != NULL)
908 s = string_cat(s, &size, &ptr, addr->shadow_message,
909 Ustrlen(addr->shadow_message));
910 }
911
912 /* Remote delivery */
913
914 else
915 {
916 if (addr->host_used != NULL)
917 {
918 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
919 US" [", addr->host_used->address, US"]");
920 if ((log_extra_selector & LX_outgoing_port) != 0)
921 s = string_append(s, &size, &ptr, 2, US":", string_sprintf("%d",
922 addr->host_used->port));
923 if (continue_sequence > 1)
924 s = string_cat(s, &size, &ptr, US"*", 1);
925 }
926
927 #ifdef SUPPORT_TLS
928 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
929 s = string_append(s, &size, &ptr, 2, US" X=", addr->cipher);
930 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
931 addr->cipher != NULL)
932 s = string_append(s, &size, &ptr, 2, US" CV=",
933 testflag(addr, af_cert_verified)? "yes":"no");
934 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
935 s = string_append(s, &size, &ptr, 3, US" DN=\"", addr->peerdn, US"\"");
936 #endif
937
938 if ((log_extra_selector & LX_smtp_confirmation) != 0 &&
939 addr->message != NULL)
940 {
941 int i;
942 uschar *p = big_buffer;
943 uschar *ss = addr->message;
944 *p++ = '\"';
945 for (i = 0; i < 100 && ss[i] != 0; i++)
946 {
947 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\';
948 *p++ = ss[i];
949 }
950 *p++ = '\"';
951 *p = 0;
952 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
953 }
954 }
955
956 /* Time on queue and actual time taken to deliver */
957
958 if ((log_extra_selector & LX_queue_time) != 0)
959 {
960 s = string_append(s, &size, &ptr, 2, US" QT=",
961 readconf_printtime(time(NULL) - received_time));
962 }
963
964 if ((log_extra_selector & LX_deliver_time) != 0)
965 {
966 s = string_append(s, &size, &ptr, 2, US" DT=",
967 readconf_printtime(addr->more_errno));
968 }
969
970 /* string_cat() always leaves room for the terminator. Release the
971 store we used to build the line after writing it. */
972
973 s[ptr] = 0;
974 log_write(0, LOG_MAIN, "%s", s);
975 store_reset(reset_point);
976 }
977
978
979 /* Soft failure, or local delivery process failed; freezing may be
980 requested. */
981
982 else if (result == DEFER || result == PANIC)
983 {
984 if (result == PANIC) logflags |= LOG_PANIC;
985
986 /* This puts them on the chain in reverse order. Do not change this, because
987 the code for handling retries assumes that the one with the retry
988 information is last. */
989
990 addr->next = addr_defer;
991 addr_defer = addr;
992
993 /* The only currently implemented special action is to freeze the
994 message. Logging of this is done later, just before the -H file is
995 updated. */
996
997 if (addr->special_action == SPECIAL_FREEZE)
998 {
999 deliver_freeze = TRUE;
1000 deliver_frozen_at = time(NULL);
1001 update_spool = TRUE;
1002 }
1003
1004 /* If doing a 2-stage queue run, we skip writing to either the message
1005 log or the main log for SMTP defers. */
1006
1007 if (!queue_2stage || addr->basic_errno != 0)
1008 {
1009 uschar ss[32];
1010
1011 /* For errors of the type "retry time not reached" (also remotes skipped
1012 on queue run), logging is controlled by L_retry_defer. Note that this kind
1013 of error number is negative, and all the retry ones are less than any
1014 others. */
1015
1016 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1017 L_retry_defer : 0;
1018
1019 /* Build up the line that is used for both the message log and the main
1020 log. */
1021
1022 s = reset_point = store_get(size);
1023 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1024
1025 /* Either driver_name contains something and driver_kind contains
1026 " router" or " transport" (note the leading space), or driver_name is
1027 a null string and driver_kind contains "routing" without the leading
1028 space, if all routing has been deferred. When a domain has been held,
1029 so nothing has been done at all, both variables contain null strings. */
1030
1031 if (driver_name == NULL)
1032 {
1033 if (driver_kind != NULL)
1034 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1035 }
1036 else
1037 {
1038 if (driver_kind[1] == 't' && addr->router != NULL)
1039 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1040 Ustrcpy(ss, " ?=");
1041 ss[1] = toupper(driver_kind[1]);
1042 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1043 }
1044
1045 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1046 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1047
1048 if (addr->basic_errno > 0)
1049 s = string_append(s, &size, &ptr, 2, US": ",
1050 US strerror(addr->basic_errno));
1051
1052 if (addr->message != NULL)
1053 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1054
1055 s[ptr] = 0;
1056
1057 /* Log the deferment in the message log, but don't clutter it
1058 up with retry-time defers after the first delivery attempt. */
1059
1060 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1061 deliver_msglog("%s %s\n", now, s);
1062
1063 /* Write the main log and reset the store */
1064
1065 log_write(use_log_selector, logflags, "== %s", s);
1066 store_reset(reset_point);
1067 }
1068 }
1069
1070
1071 /* Hard failure. If there is an address to which an error message can be sent,
1072 put this address on the failed list. If not, put it on the deferred list and
1073 freeze the mail message for human attention. The latter action can also be
1074 explicitly requested by a router or transport. */
1075
1076 else
1077 {
1078 /* If this is a delivery error, or a message for which no replies are
1079 wanted, and the message's age is greater than ignore_bounce_errors_after,
1080 force the af_ignore_error flag. This will cause the address to be discarded
1081 later (with a log entry). */
1082
1083 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1084 setflag(addr, af_ignore_error);
1085
1086 /* Freeze the message if requested, or if this is a bounce message (or other
1087 message with null sender) and this address does not have its own errors
1088 address. However, don't freeze if errors are being ignored. The actual code
1089 to ignore occurs later, instead of sending a message. Logging of freezing
1090 occurs later, just before writing the -H file. */
1091
1092 if (!testflag(addr, af_ignore_error) &&
1093 (addr->special_action == SPECIAL_FREEZE ||
1094 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1095 ))
1096 {
1097 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1098 (sender_local && !local_error_message)?
1099 US" (message created with -f <>)" : US" (delivery error message)";
1100 deliver_freeze = TRUE;
1101 deliver_frozen_at = time(NULL);
1102 update_spool = TRUE;
1103
1104 /* The address is put on the defer rather than the failed queue, because
1105 the message is being retained. */
1106
1107 addr->next = addr_defer;
1108 addr_defer = addr;
1109 }
1110
1111 /* Don't put the address on the nonrecipients tree yet; wait until an
1112 error message has been successfully sent. */
1113
1114 else
1115 {
1116 addr->next = addr_failed;
1117 addr_failed = addr;
1118 }
1119
1120 /* Build up the log line for the message and main logs */
1121
1122 s = reset_point = store_get(size);
1123 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1124
1125 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1126 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1127
1128 /* Return path may not be set if no delivery actually happened */
1129
1130 if (used_return_path != NULL &&
1131 (log_extra_selector & LX_return_path_on_delivery) != 0)
1132 {
1133 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1134 }
1135
1136 if (addr->router != NULL)
1137 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1138 if (addr->transport != NULL)
1139 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1140
1141 if (addr->host_used != NULL)
1142 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
1143 US" [", addr->host_used->address, US"]");
1144
1145 if (addr->basic_errno > 0)
1146 s = string_append(s, &size, &ptr, 2, US": ",
1147 US strerror(addr->basic_errno));
1148
1149 if (addr->message != NULL)
1150 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1151
1152 s[ptr] = 0;
1153
1154 /* Do the logging. For the message log, "routing failed" for those cases,
1155 just to make it clearer. */
1156
1157 if (driver_name == NULL)
1158 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1159 else
1160 deliver_msglog("%s %s\n", now, s);
1161
1162 log_write(0, LOG_MAIN, "** %s", s);
1163 store_reset(reset_point);
1164 }
1165
1166 /* Ensure logging is turned on again in all cases */
1167
1168 disable_logging = FALSE;
1169 }
1170
1171
1172
1173
1174 /*************************************************
1175 * Address-independent error *
1176 *************************************************/
1177
1178 /* This function is called when there's an error that is not dependent on a
1179 particular address, such as an expansion string failure. It puts the error into
1180 all the addresses in a batch, logs the incident on the main and panic logs, and
1181 clears the expansions. It is mostly called from local_deliver(), but can be
1182 called for a remote delivery via findugid().
1183
1184 Arguments:
1185 logit TRUE if (MAIN+PANIC) logging required
1186 addr the first of the chain of addresses
1187 code the error code
1188 format format string for error message, or NULL if already set in addr
1189 ... arguments for the format
1190
1191 Returns: nothing
1192 */
1193
1194 static void
1195 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1196 {
1197 address_item *addr2;
1198 addr->basic_errno = code;
1199
1200 if (format != NULL)
1201 {
1202 va_list ap;
1203 uschar buffer[512];
1204 va_start(ap, format);
1205 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1206 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1207 "common_error expansion was longer than %d", sizeof(buffer));
1208 va_end(ap);
1209 addr->message = string_copy(buffer);
1210 }
1211
1212 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1213 {
1214 addr2->basic_errno = code;
1215 addr2->message = addr->message;
1216 }
1217
1218 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1219 deliver_set_expansions(NULL);
1220 }
1221
1222
1223
1224
1225 /*************************************************
1226 * Check a "never users" list *
1227 *************************************************/
1228
1229 /* This function is called to check whether a uid is on one of the two "never
1230 users" lists.
1231
1232 Arguments:
1233 uid the uid to be checked
1234 nusers the list to be scanned; the first item in the list is the count
1235
1236 Returns: TRUE if the uid is on the list
1237 */
1238
1239 static BOOL
1240 check_never_users(uid_t uid, uid_t *nusers)
1241 {
1242 int i;
1243 if (nusers == NULL) return FALSE;
1244 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1245 return FALSE;
1246 }
1247
1248
1249
1250 /*************************************************
1251 * Find uid and gid for a transport *
1252 *************************************************/
1253
1254 /* This function is called for both local and remote deliveries, to find the
1255 uid/gid under which to run the delivery. The values are taken preferentially
1256 from the transport (either explicit or deliver_as_creator), then from the
1257 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1258 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1259 panic error is logged, and the function fails (which normally leads to delivery
1260 deferral).
1261
1262 Arguments:
1263 addr the address (possibly a chain)
1264 tp the transport
1265 uidp pointer to uid field
1266 gidp pointer to gid field
1267 igfp pointer to the use_initgroups field
1268
1269 Returns: FALSE if failed - error has been set in address(es)
1270 */
1271
1272 static BOOL
1273 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1274 BOOL *igfp)
1275 {
1276 uschar *nuname = NULL;
1277 BOOL gid_set = FALSE;
1278
1279 /* Default initgroups flag comes from the transport */
1280
1281 *igfp = tp->initgroups;
1282
1283 /* First see if there's a gid on the transport, either fixed or expandable.
1284 The expanding function always logs failure itself. */
1285
1286 if (tp->gid_set)
1287 {
1288 *gidp = tp->gid;
1289 gid_set = TRUE;
1290 }
1291 else if (tp->expand_gid != NULL)
1292 {
1293 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1294 &(addr->message))) gid_set = TRUE;
1295 else
1296 {
1297 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1298 return FALSE;
1299 }
1300 }
1301
1302 /* Pick up a uid from the transport if one is set. */
1303
1304 if (tp->uid_set) *uidp = tp->uid;
1305
1306 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1307 it does not provide a passwd value from which a gid can be taken. */
1308
1309 else if (tp->expand_uid != NULL)
1310 {
1311 struct passwd *pw;
1312 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1313 uidp, &(addr->message)))
1314 {
1315 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1316 return FALSE;
1317 }
1318 if (!gid_set && pw != NULL)
1319 {
1320 *gidp = pw->pw_gid;
1321 gid_set = TRUE;
1322 }
1323 }
1324
1325 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1326
1327 else if (tp->deliver_as_creator)
1328 {
1329 *uidp = originator_uid;
1330 if (!gid_set)
1331 {
1332 *gidp = originator_gid;
1333 gid_set = TRUE;
1334 }
1335 }
1336
1337 /* Otherwise see if the address specifies the uid and if so, take its
1338 initgroups flag. The gid from the address is taken only if the transport hasn't
1339 set it. In other words, a gid on the transport overrides the gid on the
1340 address. */
1341
1342 else if (testflag(addr, af_uid_set))
1343 {
1344 *uidp = addr->uid;
1345 *igfp = testflag(addr, af_initgroups);
1346 if (!gid_set)
1347 {
1348 *gidp = addr->gid;
1349 gid_set = TRUE;
1350 }
1351 }
1352
1353 /* Nothing has specified the uid - default to the Exim user, and group if the
1354 gid is not set. */
1355
1356 else
1357 {
1358 *uidp = exim_uid;
1359 if (!gid_set)
1360 {
1361 *gidp = exim_gid;
1362 gid_set = TRUE;
1363 }
1364 }
1365
1366 /* If no gid is set, it is a disaster. */
1367
1368 if (!gid_set)
1369 {
1370 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1371 "%s transport", tp->name);
1372 return FALSE;
1373 }
1374
1375 /* Check that the uid is not on the lists of banned uids that may not be used
1376 for delivery processes. */
1377
1378 if (check_never_users(*uidp, never_users))
1379 nuname = US"never_users";
1380 else if (check_never_users(*uidp, fixed_never_users))
1381 nuname = US"fixed_never_users";
1382
1383 if (nuname != NULL)
1384 {
1385 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1386 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1387 return FALSE;
1388 }
1389
1390 /* All is well */
1391
1392 return TRUE;
1393 }
1394
1395
1396
1397
1398 /*************************************************
1399 * Check the size of a message for a transport *
1400 *************************************************/
1401
1402 /* Checks that the message isn't too big for the selected transport.
1403 This is called only when it is known that the limit is set.
1404
1405 Arguments:
1406 tp the transport
1407 addr the (first) address being delivered
1408
1409 Returns: OK
1410 DEFER expansion failed or did not yield an integer
1411 FAIL message too big
1412 */
1413
1414 int
1415 check_message_size(transport_instance *tp, address_item *addr)
1416 {
1417 int rc = OK;
1418 int size_limit;
1419
1420 deliver_set_expansions(addr);
1421 size_limit = expand_string_integer(tp->message_size_limit);
1422 deliver_set_expansions(NULL);
1423
1424 if (size_limit < 0)
1425 {
1426 rc = DEFER;
1427 if (size_limit == -1)
1428 addr->message = string_sprintf("failed to expand message_size_limit "
1429 "in %s transport: %s", tp->name, expand_string_message);
1430 else
1431 addr->message = string_sprintf("invalid message_size_limit "
1432 "in %s transport: %s", tp->name, expand_string_message);
1433 }
1434 else if (size_limit > 0 && message_size > size_limit)
1435 {
1436 rc = FAIL;
1437 addr->message =
1438 string_sprintf("message is too big (transport limit = %d)",
1439 size_limit);
1440 }
1441
1442 return rc;
1443 }
1444
1445
1446
1447 /*************************************************
1448 * Transport-time check for a previous delivery *
1449 *************************************************/
1450
1451 /* Check that this base address hasn't previously been delivered to its routed
1452 transport. If it has been delivered, mark it done. The check is necessary at
1453 delivery time in order to handle homonymic addresses correctly in cases where
1454 the pattern of redirection changes between delivery attempts (so the unique
1455 fields change). Non-homonymic previous delivery is detected earlier, at routing
1456 time (which saves unnecessary routing).
1457
1458 Arguments:
1459 addr the address item
1460 testing TRUE if testing wanted only, without side effects
1461
1462 Returns: TRUE if previously delivered by the transport
1463 */
1464
1465 static BOOL
1466 previously_transported(address_item *addr, BOOL testing)
1467 {
1468 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1469 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1470
1471 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1472 {
1473 DEBUG(D_deliver|D_route|D_transport)
1474 debug_printf("%s was previously delivered (%s transport): discarded\n",
1475 addr->address, addr->transport->name);
1476 if (!testing) child_done(addr, tod_stamp(tod_log));
1477 return TRUE;
1478 }
1479
1480 return FALSE;
1481 }
1482
1483
1484
1485
1486 /*************************************************
1487 * Perform a local delivery *
1488 *************************************************/
1489
1490 /* Each local delivery is performed in a separate process which sets its
1491 uid and gid as specified. This is a safer way than simply changing and
1492 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1493 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1494 all systems have seteuid().
1495
1496 If the uid/gid are specified in the transport_instance, they are used; the
1497 transport initialization must ensure that either both or neither are set.
1498 Otherwise, the values associated with the address are used. If neither are set,
1499 it is a configuration error.
1500
1501 The transport or the address may specify a home directory (transport over-
1502 rides), and if they do, this is set as $home. If neither have set a working
1503 directory, this value is used for that as well. Otherwise $home is left unset
1504 and the cwd is set to "/" - a directory that should be accessible to all users.
1505
1506 Using a separate process makes it more complicated to get error information
1507 back. We use a pipe to pass the return code and also an error code and error
1508 text string back to the parent process.
1509
1510 Arguments:
1511 addr points to an address block for this delivery; for "normal" local
1512 deliveries this is the only address to be delivered, but for
1513 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1514 a number of addresses can be handled simultaneously, and in this
1515 case addr will point to a chain of addresses with the same
1516 characteristics.
1517
1518 shadowing TRUE if running a shadow transport; this causes output from pipes
1519 to be ignored.
1520
1521 Returns: nothing
1522 */
1523
1524 static void
1525 deliver_local(address_item *addr, BOOL shadowing)
1526 {
1527 BOOL use_initgroups;
1528 uid_t uid;
1529 gid_t gid;
1530 int status, len, rc;
1531 int pfd[2];
1532 pid_t pid;
1533 uschar *working_directory;
1534 address_item *addr2;
1535 transport_instance *tp = addr->transport;
1536
1537 /* Set up the return path from the errors or sender address. If the transport
1538 has its own return path setting, expand it and replace the existing value. */
1539
1540 return_path = (addr->p.errors_address != NULL)?
1541 addr->p.errors_address : sender_address;
1542
1543 if (tp->return_path != NULL)
1544 {
1545 uschar *new_return_path = expand_string(tp->return_path);
1546 if (new_return_path == NULL)
1547 {
1548 if (!expand_string_forcedfail)
1549 {
1550 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1551 US"Failed to expand return path \"%s\" in %s transport: %s",
1552 tp->return_path, tp->name, expand_string_message);
1553 return;
1554 }
1555 }
1556 else return_path = new_return_path;
1557 }
1558
1559 /* For local deliveries, one at a time, the value used for logging can just be
1560 set directly, once and for all. */
1561
1562 used_return_path = return_path;
1563
1564 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1565 gets put into the address(es), and the expansions are unset, so we can just
1566 return. */
1567
1568 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1569
1570 /* See if either the transport or the address specifies a home and/or a current
1571 working directory. Expand it if necessary. If nothing is set, use "/", for the
1572 working directory, which is assumed to be a directory to which all users have
1573 access. It is necessary to be in a visible directory for some operating systems
1574 when running pipes, as some commands (e.g. "rm" under Solaris 2.5) require
1575 this. */
1576
1577 deliver_home = (tp->home_dir != NULL)? tp->home_dir :
1578 (addr->home_dir != NULL)? addr->home_dir : NULL;
1579
1580 if (deliver_home != NULL && !testflag(addr, af_home_expanded))
1581 {
1582 uschar *rawhome = deliver_home;
1583 deliver_home = NULL; /* in case it contains $home */
1584 deliver_home = expand_string(rawhome);
1585 if (deliver_home == NULL)
1586 {
1587 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1588 "to expand for %s transport: %s", rawhome, tp->name,
1589 expand_string_message);
1590 return;
1591 }
1592 if (*deliver_home != '/')
1593 {
1594 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1595 "is not absolute for %s transport", deliver_home, tp->name);
1596 return;
1597 }
1598 }
1599
1600 working_directory = (tp->current_dir != NULL)? tp->current_dir :
1601 (addr->current_dir != NULL)? addr->current_dir : NULL;
1602
1603 if (working_directory != NULL)
1604 {
1605 uschar *raw = working_directory;
1606 working_directory = expand_string(raw);
1607 if (working_directory == NULL)
1608 {
1609 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1610 "failed to expand for %s transport: %s", raw, tp->name,
1611 expand_string_message);
1612 return;
1613 }
1614 if (*working_directory != '/')
1615 {
1616 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1617 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1618 return;
1619 }
1620 }
1621 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1622
1623 /* If one of the return_output flags is set on the transport, create and open a
1624 file in the message log directory for the transport to write its output onto.
1625 This is mainly used by pipe transports. The file needs to be unique to the
1626 address. This feature is not available for shadow transports. */
1627
1628 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1629 tp->log_output || tp->log_fail_output))
1630 {
1631 uschar *error;
1632 addr->return_filename =
1633 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1634 message_id, getpid(), return_count++);
1635 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1636 if (addr->return_file < 0)
1637 {
1638 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1639 "to return message: %s", error, tp->name, strerror(errno));
1640 return;
1641 }
1642 }
1643
1644 /* Create the pipe for inter-process communication. */
1645
1646 if (pipe(pfd) != 0)
1647 {
1648 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1649 strerror(errno));
1650 return;
1651 }
1652
1653 /* Now fork the process to do the real work in the subprocess, but first
1654 ensure that all cached resources are freed so that the subprocess starts with
1655 a clean slate and doesn't interfere with the parent process. */
1656
1657 search_tidyup();
1658
1659 if ((pid = fork()) == 0)
1660 {
1661 BOOL replicate = TRUE;
1662
1663 /* Prevent core dumps, as we don't want them in users' home directories.
1664 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1665 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1666 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1667 complain if the error is "not supported". */
1668
1669 #ifdef RLIMIT_CORE
1670 struct rlimit rl;
1671 rl.rlim_cur = 0;
1672 rl.rlim_max = 0;
1673 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1674 {
1675 #ifdef SETRLIMIT_NOT_SUPPORTED
1676 if (errno != ENOSYS && errno != ENOTSUP)
1677 #endif
1678 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1679 strerror(errno));
1680 }
1681 #endif
1682
1683 /* Reset the random number generator, so different processes don't all
1684 have the same sequence. */
1685
1686 random_seed = 0;
1687
1688 /* If the transport has a setup entry, call this first, while still
1689 privileged. (Appendfile uses this to expand quota, for example, while
1690 able to read private files.) */
1691
1692 if (addr->transport->setup != NULL)
1693 {
1694 switch((addr->transport->setup)(addr->transport, addr, NULL,
1695 &(addr->message)))
1696 {
1697 case DEFER:
1698 addr->transport_return = DEFER;
1699 goto PASS_BACK;
1700
1701 case FAIL:
1702 addr->transport_return = PANIC;
1703 goto PASS_BACK;
1704 }
1705 }
1706
1707 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1708 when the process becomes unprivileged, it won't be able to write to the
1709 process log. SIGHUP is ignored throughout exim, except when it is being
1710 run as a daemon. */
1711
1712 signal(SIGINT, SIG_IGN);
1713 signal(SIGTERM, SIG_IGN);
1714 signal(SIGUSR1, SIG_IGN);
1715
1716 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1717 half - for transports that exec things (e.g. pipe). Then set the required
1718 gid/uid. */
1719
1720 close(pfd[pipe_read]);
1721 fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1722 FD_CLOEXEC);
1723 exim_setugid(uid, gid, use_initgroups,
1724 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1725 addr->address, addr->transport->name));
1726
1727 DEBUG(D_deliver)
1728 {
1729 address_item *batched;
1730 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1731 for (batched = addr->next; batched != NULL; batched = batched->next)
1732 debug_printf("additional batched address: %s\n", batched->address);
1733 }
1734
1735 /* Set an appropriate working directory. */
1736
1737 if (Uchdir(working_directory) < 0)
1738 {
1739 addr->transport_return = DEFER;
1740 addr->basic_errno = errno;
1741 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1742 }
1743
1744 /* If successful, call the transport */
1745
1746 else
1747 {
1748 BOOL ok = TRUE;
1749 set_process_info("delivering %s to %s using %s", message_id,
1750 addr->local_part, addr->transport->name);
1751
1752 /* If a transport filter has been specified, set up its argument list.
1753 Any errors will get put into the address, and FALSE yielded. */
1754
1755 if (addr->transport->filter_command != NULL)
1756 {
1757 ok = transport_set_up_command(&transport_filter_argv,
1758 addr->transport->filter_command,
1759 TRUE, PANIC, addr, US"transport filter", NULL);
1760 transport_filter_timeout = addr->transport->filter_timeout;
1761 }
1762 else transport_filter_argv = NULL;
1763
1764 if (ok)
1765 {
1766 debug_print_string(addr->transport->debug_string);
1767 replicate = !(addr->transport->info->code)(addr->transport, addr);
1768 }
1769 }
1770
1771 /* Pass the results back down the pipe. If necessary, first replicate the
1772 status in the top address to the others in the batch. The label is the
1773 subject of a goto when a call to the transport's setup function fails. We
1774 pass the pointer to the transport back in case it got changed as a result of
1775 file_format in appendfile. */
1776
1777 PASS_BACK:
1778
1779 if (replicate) replicate_status(addr);
1780 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1781 {
1782 int i;
1783 int local_part_length = Ustrlen(addr2->local_part);
1784 uschar *s;
1785
1786 write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int));
1787 write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count));
1788 write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags));
1789 write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int));
1790 write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int));
1791 write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int));
1792 write(pfd[pipe_write], (void *)&(addr2->transport),
1793 sizeof(transport_instance *));
1794
1795 /* For a file delivery, pass back the local part, in case the original
1796 was only part of the final delivery path. This gives more complete
1797 logging. */
1798
1799 if (testflag(addr2, af_file))
1800 {
1801 write(pfd[pipe_write], (void *)&local_part_length, sizeof(int));
1802 write(pfd[pipe_write], addr2->local_part, local_part_length);
1803 }
1804
1805 /* Now any messages */
1806
1807 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
1808 {
1809 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
1810 write(pfd[pipe_write], (void *)&message_length, sizeof(int));
1811 if (message_length > 0) write(pfd[pipe_write], s, message_length);
1812 }
1813 }
1814
1815 /* OK, this process is now done. Free any cached resources that it opened,
1816 and close the pipe we were writing down before exiting. */
1817
1818 close(pfd[pipe_write]);
1819 search_tidyup();
1820 exit(EXIT_SUCCESS);
1821 }
1822
1823 /* Back in the main process: panic if the fork did not succeed. This seems
1824 better than returning an error - if forking is failing it is probably best
1825 not to try other deliveries for this message. */
1826
1827 if (pid < 0)
1828 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
1829 addr->address);
1830
1831 /* Read the pipe to get the delivery status codes and error messages. Our copy
1832 of the writing end must be closed first, as otherwise read() won't return zero
1833 on an empty pipe. We check that a status exists for each address before
1834 overwriting the address structure. If data is missing, the default DEFER status
1835 will remain. Afterwards, close the reading end. */
1836
1837 close(pfd[pipe_write]);
1838
1839 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1840 {
1841 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
1842 if (len > 0)
1843 {
1844 int i;
1845 uschar **sptr;
1846
1847 addr2->transport_return = status;
1848 len = read(pfd[pipe_read], (void *)&transport_count,
1849 sizeof(transport_count));
1850 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
1851 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
1852 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
1853 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
1854 len = read(pfd[pipe_read], (void *)&(addr2->transport),
1855 sizeof(transport_instance *));
1856
1857 if (testflag(addr2, af_file))
1858 {
1859 int local_part_length;
1860 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
1861 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
1862 big_buffer[local_part_length] = 0;
1863 addr2->local_part = string_copy(big_buffer);
1864 }
1865
1866 for (i = 0, sptr = &(addr2->message); i < 2;
1867 i++, sptr = &(addr2->user_message))
1868 {
1869 int message_length;
1870 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
1871 if (message_length > 0)
1872 {
1873 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
1874 if (len > 0) *sptr = string_copy(big_buffer);
1875 }
1876 }
1877 }
1878
1879 else
1880 {
1881 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
1882 "from delivery subprocess", addr2->unique);
1883 break;
1884 }
1885 }
1886
1887 close(pfd[pipe_read]);
1888
1889 /* Unless shadowing, write all successful addresses immediately to the journal
1890 file, to ensure they are recorded asap. For homonymic addresses, use the base
1891 address plus the transport name. Failure to write the journal is panic-worthy,
1892 but don't stop, as it may prove possible subsequently to update the spool file
1893 in order to record the delivery. */
1894
1895 if (!shadowing)
1896 {
1897 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1898 {
1899 if (addr2->transport_return != OK) continue;
1900
1901 if (testflag(addr2, af_homonym))
1902 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
1903 else
1904 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
1905
1906 /* In the test harness, wait just a bit to let the subprocess finish off
1907 any debug output etc first. */
1908
1909 if (running_in_test_harness) millisleep(300);
1910
1911 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
1912 len = Ustrlen(big_buffer);
1913 if (write(journal_fd, big_buffer, len) != len)
1914 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
1915 big_buffer, strerror(errno));
1916 }
1917
1918 /* Ensure the journal file is pushed out to disk. */
1919
1920 if (fsync(journal_fd) < 0)
1921 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
1922 strerror(errno));
1923 }
1924
1925 /* Wait for the process to finish. If it terminates with a non-zero code,
1926 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
1927 status values of all the addresses as they are. Take care to handle the case
1928 when the subprocess doesn't seem to exist. This has been seen on one system
1929 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
1930 happens, wait() doesn't recognize the termination of child processes. Exim now
1931 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
1932
1933 while ((rc = wait(&status)) != pid)
1934 {
1935 if (rc < 0 && errno == ECHILD) /* Process has vanished */
1936 {
1937 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
1938 addr->transport->driver_name);
1939 status = 0;
1940 break;
1941 }
1942 }
1943
1944 if ((status & 0xffff) != 0)
1945 {
1946 int msb = (status >> 8) & 255;
1947 int lsb = status & 255;
1948 int code = (msb == 0)? (lsb & 0x7f) : msb;
1949 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
1950 addr->special_action = SPECIAL_FREEZE;
1951 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
1952 "status 0x%04x: %s %d",
1953 addr->transport->driver_name,
1954 status,
1955 (msb == 0)? "terminated by signal" : "exit code",
1956 code);
1957 }
1958
1959 /* If SPECIAL_WARN is set in the top address, send a warning message. */
1960
1961 if (addr->special_action == SPECIAL_WARN &&
1962 addr->transport->warn_message != NULL)
1963 {
1964 int fd;
1965 uschar *warn_message;
1966
1967 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
1968
1969 warn_message = expand_string(addr->transport->warn_message);
1970 if (warn_message == NULL)
1971 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
1972 "message for %s transport): %s", addr->transport->warn_message,
1973 addr->transport->name, expand_string_message);
1974 else
1975 {
1976 pid_t pid = child_open_exim(&fd);
1977 if (pid > 0)
1978 {
1979 FILE *f = fdopen(fd, "wb");
1980
1981 if (errors_reply_to != NULL)
1982 fprintf(f, "Reply-To: %s\n", errors_reply_to);
1983 fprintf(f, "Auto-Submitted: auto-generated\n");
1984 fprintf(f, "From: Mail Delivery System <Mailer-Daemon@%s>\n",
1985 qualify_domain_sender);
1986 fprintf(f, "%s", CS warn_message);
1987
1988 /* Close and wait for child process to complete, without a timeout. */
1989
1990 fclose(f);
1991 (void)child_close(pid, 0);
1992 }
1993 }
1994
1995 addr->special_action = SPECIAL_NONE;
1996 }
1997 }
1998
1999
2000
2001 /*************************************************
2002 * Do local deliveries *
2003 *************************************************/
2004
2005 /* This function processes the list of addresses in addr_local. True local
2006 deliveries are always done one address at a time. However, local deliveries can
2007 be batched up in some cases. Typically this is when writing batched SMTP output
2008 files for use by some external transport mechanism, or when running local
2009 deliveries over LMTP.
2010
2011 Arguments: None
2012 Returns: Nothing
2013 */
2014
2015 static void
2016 do_local_deliveries(void)
2017 {
2018 open_db dbblock;
2019 open_db *dbm_file = NULL;
2020 time_t now = time(NULL);
2021
2022 /* Loop until we have exhausted the supply of local deliveries */
2023
2024 while (addr_local != NULL)
2025 {
2026 time_t delivery_start;
2027 int deliver_time;
2028 address_item *addr2, *addr3, *nextaddr;
2029 int logflags = LOG_MAIN;
2030 int logchar = dont_deliver? '*' : '=';
2031 transport_instance *tp;
2032
2033 /* Pick the first undelivered address off the chain */
2034
2035 address_item *addr = addr_local;
2036 addr_local = addr->next;
2037 addr->next = NULL;
2038
2039 DEBUG(D_deliver|D_transport)
2040 debug_printf("--------> %s <--------\n", addr->address);
2041
2042 /* An internal disaster if there is no transport. Should not occur! */
2043
2044 if ((tp = addr->transport) == NULL)
2045 {
2046 logflags |= LOG_PANIC;
2047 disable_logging = FALSE; /* Jic */
2048 addr->message =
2049 (addr->router != NULL)?
2050 string_sprintf("No transport set by %s router", addr->router->name)
2051 :
2052 string_sprintf("No transport set by system filter");
2053 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2054 continue;
2055 }
2056
2057 /* Check that this base address hasn't previously been delivered to this
2058 transport. The check is necessary at this point to handle homonymic addresses
2059 correctly in cases where the pattern of redirection changes between delivery
2060 attempts. Non-homonymic previous delivery is detected earlier, at routing
2061 time. */
2062
2063 if (previously_transported(addr, FALSE)) continue;
2064
2065 /* There are weird cases where logging is disabled */
2066
2067 disable_logging = tp->disable_logging;
2068
2069 /* Check for batched addresses and possible amalgamation. File deliveries can
2070 never be batched. Skip all the work if either batch_max <= 1 or there aren't
2071 any other addresses for local delivery. */
2072
2073 if (!testflag(addr, af_file) && tp->batch_max > 1 && addr_local != NULL)
2074 {
2075 int batch_count = 1;
2076 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2077 BOOL uses_lp = readconf_depends((driver_instance *)tp, US"local_part");
2078 uschar *batch_id = NULL;
2079 address_item **anchor = &addr_local;
2080 address_item *last = addr;
2081 address_item *next;
2082
2083 /* Expand the batch_id string for comparison with other addresses.
2084 Expansion failure suppresses batching. */
2085
2086 if (tp->batch_id != NULL)
2087 {
2088 deliver_set_expansions(addr);
2089 batch_id = expand_string(tp->batch_id);
2090 deliver_set_expansions(NULL);
2091 if (batch_id == NULL)
2092 {
2093 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2094 "in %s transport (%s): %s", tp->name, addr->address,
2095 expand_string_message);
2096 batch_count = tp->batch_max;
2097 }
2098 }
2099
2100 /* Until we reach the batch_max limit, pick off addresses which have the
2101 same characteristics. These are:
2102
2103 same transport
2104 not previously delivered (see comment about 50 lines above)
2105 same local part if the transport's configuration contains $local_part
2106 same domain if the transport's configuration contains $domain
2107 same errors address
2108 same additional headers
2109 same headers to be removed
2110 same uid/gid for running the transport
2111 same first host if a host list is set
2112 */
2113
2114 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2115 {
2116 BOOL ok =
2117 tp == next->transport &&
2118 !previously_transported(next, TRUE) &&
2119 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2120 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2121 same_strings(next->p.errors_address, addr->p.errors_address) &&
2122 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2123 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2124 same_ugid(tp, addr, next) &&
2125 ((addr->host_list == NULL && next->host_list == NULL) ||
2126 (addr->host_list != NULL && next->host_list != NULL &&
2127 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2128
2129 /* If the transport has a batch_id setting, batch_id will be non-NULL
2130 from the expansion outside the loop. Expand for this address and compare.
2131 Expansion failure makes this address ineligible for batching. */
2132
2133 if (ok && batch_id != NULL)
2134 {
2135 uschar *bid;
2136 address_item *save_nextnext = next->next;
2137 next->next = NULL; /* Expansion for a single address */
2138 deliver_set_expansions(next);
2139 next->next = save_nextnext;
2140 bid = expand_string(tp->batch_id);
2141 deliver_set_expansions(NULL);
2142 if (bid == NULL)
2143 {
2144 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2145 "in %s transport (%s): %s", tp->name, next->address,
2146 expand_string_message);
2147 ok = FALSE;
2148 }
2149 else ok = (Ustrcmp(batch_id, bid) == 0);
2150 }
2151
2152 /* Take address into batch if OK. */
2153
2154 if (ok)
2155 {
2156 *anchor = next->next; /* Include the address */
2157 next->next = NULL;
2158 last->next = next;
2159 last = next;
2160 batch_count++;
2161 }
2162 else anchor = &(next->next); /* Skip the address */
2163 }
2164 }
2165
2166 /* We now have one or more addresses that can be delivered in a batch. Check
2167 whether the transport is prepared to accept a message of this size. If not,
2168 fail them all forthwith. If the expansion fails, or does not yield an
2169 integer, defer delivery. */
2170
2171 if (tp->message_size_limit != NULL)
2172 {
2173 int rc = check_message_size(tp, addr);
2174 if (rc != OK)
2175 {
2176 replicate_status(addr);
2177 while (addr != NULL)
2178 {
2179 addr2 = addr->next;
2180 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2181 addr = addr2;
2182 }
2183 continue; /* With next batch of addresses */
2184 }
2185 }
2186
2187 /* If we are not running the queue, or if forcing, all deliveries will be
2188 attempted. Otherwise, we must respect the retry times for each address. Even
2189 when not doing this, we need to set up the retry key string, and determine
2190 whether a retry record exists, because after a successful delivery, a delete
2191 retry item must be set up. Keep the retry database open only for the duration
2192 of these checks, rather than for all local deliveries, because some local
2193 deliveries (e.g. to pipes) can take a substantial time. */
2194
2195 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2196 if (dbm_file == NULL)
2197 {
2198 DEBUG(D_deliver|D_retry|D_hints_lookup)
2199 debug_printf("no retry data available\n");
2200 }
2201
2202 addr2 = addr;
2203 addr3 = NULL;
2204 while (addr2 != NULL)
2205 {
2206 BOOL ok = TRUE; /* to deliver this address */
2207 uschar *retry_key;
2208
2209 /* Set up the retry key to include the domain or not, and change its
2210 leading character from "R" to "T". Must make a copy before doing this,
2211 because the old key may be pointed to from a "delete" retry item after
2212 a routing delay. */
2213
2214 retry_key = string_copy(
2215 (tp->retry_use_local_part)? addr2->address_retry_key :
2216 addr2->domain_retry_key);
2217 *retry_key = 'T';
2218
2219 /* Inspect the retry data. If there is no hints file, delivery happens. */
2220
2221 if (dbm_file != NULL)
2222 {
2223 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2224
2225 /* If there is no retry record, delivery happens. If there is,
2226 remember it exists so it can be deleted after a successful delivery. */
2227
2228 if (retry_record != NULL)
2229 {
2230 setflag(addr2, af_lt_retry_exists);
2231
2232 /* A retry record exists for this address. If queue running and not
2233 forcing, inspect its contents. If the record is too old, or if its
2234 retry time has come, or if it has passed its cutoff time, delivery
2235 will go ahead. */
2236
2237 DEBUG(D_retry)
2238 {
2239 debug_printf("retry record exists: age=%d (max=%d)\n",
2240 (int)(now - retry_record->time_stamp), retry_data_expire);
2241 debug_printf(" time to retry = %d expired = %d\n",
2242 (int)(now - retry_record->next_try), retry_record->expired);
2243 }
2244
2245 if (queue_running && !deliver_force)
2246 {
2247 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2248 (now >= retry_record->next_try) ||
2249 retry_record->expired;
2250
2251 /* If we haven't reached the retry time, there is one more check
2252 to do, which is for the ultimate address timeout. */
2253
2254 if (!ok)
2255 {
2256 retry_config *retry =
2257 retry_find_config(retry_key+2, addr2->domain,
2258 retry_record->basic_errno,
2259 retry_record->more_errno);
2260
2261 DEBUG(D_deliver|D_retry)
2262 debug_printf("retry time not reached for %s: "
2263 "checking ultimate address timeout\n", addr2->address);
2264
2265 if (retry != NULL && retry->rules != NULL)
2266 {
2267 retry_rule *last_rule;
2268 for (last_rule = retry->rules;
2269 last_rule->next != NULL;
2270 last_rule = last_rule->next);
2271 if (now - received_time > last_rule->timeout) ok = TRUE;
2272 }
2273 else ok = TRUE; /* No rule => timed out */
2274
2275 DEBUG(D_deliver|D_retry)
2276 {
2277 if (ok) debug_printf("on queue longer than maximum retry for "
2278 "address - allowing delivery\n");
2279 }
2280 }
2281 }
2282 }
2283 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2284 }
2285
2286 /* This address is to be delivered. Leave it on the chain. */
2287
2288 if (ok)
2289 {
2290 addr3 = addr2;
2291 addr2 = addr2->next;
2292 }
2293
2294 /* This address is to be deferred. Take it out of the chain, and
2295 post-process it as complete. Must take it out of the chain first,
2296 because post processing puts it on another chain. */
2297
2298 else
2299 {
2300 address_item *this = addr2;
2301 this->message = US"Retry time not yet reached";
2302 this->basic_errno = ERRNO_LRETRY;
2303 if (addr3 == NULL) addr2 = addr = addr2->next;
2304 else addr2 = addr3->next = addr2->next;
2305 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2306 }
2307 }
2308
2309 if (dbm_file != NULL) dbfn_close(dbm_file);
2310
2311 /* If there are no addresses left on the chain, they all deferred. Loop
2312 for the next set of addresses. */
2313
2314 if (addr == NULL) continue;
2315
2316 /* So, finally, we do have some addresses that can be passed to the
2317 transport. Before doing so, set up variables that are relevant to a
2318 single delivery. */
2319
2320 deliver_set_expansions(addr);
2321 delivery_start = time(NULL);
2322 deliver_local(addr, FALSE);
2323 deliver_time = (int)(time(NULL) - delivery_start);
2324
2325 /* If a shadow transport (which must perforce be another local transport), is
2326 defined, and its condition is met, we must pass the message to the shadow
2327 too, but only those addresses that succeeded. We do this by making a new
2328 chain of addresses - also to keep the original chain uncontaminated. We must
2329 use a chain rather than doing it one by one, because the shadow transport may
2330 batch.
2331
2332 NOTE: if the condition fails because of a lookup defer, there is nothing we
2333 can do! */
2334
2335 if (tp->shadow != NULL &&
2336 (tp->shadow_condition == NULL ||
2337 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2338 {
2339 transport_instance *stp;
2340 address_item *shadow_addr = NULL;
2341 address_item **last = &shadow_addr;
2342
2343 for (stp = transports; stp != NULL; stp = stp->next)
2344 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2345
2346 if (stp == NULL)
2347 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2348 tp->shadow);
2349
2350 /* Pick off the addresses that have succeeded, and make clones. Put into
2351 the shadow_message field a pointer to the shadow_message field of the real
2352 address. */
2353
2354 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2355 {
2356 if (addr2->transport_return != OK) continue;
2357 addr3 = store_get(sizeof(address_item));
2358 *addr3 = *addr2;
2359 addr3->next = NULL;
2360 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2361 addr3->transport = stp;
2362 addr3->transport_return = DEFER;
2363 addr3->return_filename = NULL;
2364 addr3->return_file = -1;
2365 *last = addr3;
2366 last = &(addr3->next);
2367 }
2368
2369 /* If we found any addresses to shadow, run the delivery, and stick any
2370 message back into the shadow_message field in the original. */
2371
2372 if (shadow_addr != NULL)
2373 {
2374 int save_count = transport_count;
2375
2376 DEBUG(D_deliver|D_transport)
2377 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2378 deliver_local(shadow_addr, TRUE);
2379
2380 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2381 {
2382 int sresult = shadow_addr->transport_return;
2383 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2384 string_sprintf(" ST=%s", stp->name) :
2385 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2386 (shadow_addr->basic_errno <= 0)?
2387 US"" : US strerror(shadow_addr->basic_errno),
2388 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2389 US"" : US": ",
2390 (shadow_addr->message != NULL)? shadow_addr->message :
2391 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2392
2393 DEBUG(D_deliver|D_transport)
2394 debug_printf("%s shadow transport returned %s for %s\n",
2395 stp->name,
2396 (sresult == OK)? "OK" :
2397 (sresult == DEFER)? "DEFER" :
2398 (sresult == FAIL)? "FAIL" :
2399 (sresult == PANIC)? "PANIC" : "?",
2400 shadow_addr->address);
2401 }
2402
2403 DEBUG(D_deliver|D_transport)
2404 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2405
2406 transport_count = save_count; /* Restore original transport count */
2407 }
2408 }
2409
2410 /* Cancel the expansions that were set up for the delivery. */
2411
2412 deliver_set_expansions(NULL);
2413
2414 /* Now we can process the results of the real transport. We must take each
2415 address off the chain first, because post_process_one() puts it on another
2416 chain. */
2417
2418 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2419 {
2420 int result = addr2->transport_return;
2421 nextaddr = addr2->next;
2422
2423 DEBUG(D_deliver|D_transport)
2424 debug_printf("%s transport returned %s for %s\n",
2425 tp->name,
2426 (result == OK)? "OK" :
2427 (result == DEFER)? "DEFER" :
2428 (result == FAIL)? "FAIL" :
2429 (result == PANIC)? "PANIC" : "?",
2430 addr2->address);
2431
2432 /* If there is a retry_record, or if delivery is deferred, build a retry
2433 item for setting a new retry time or deleting the old retry record from
2434 the database. These items are handled all together after all addresses
2435 have been handled (so the database is open just for a short time for
2436 updating). */
2437
2438 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2439 {
2440 int flags = (result == DEFER)? 0 : rf_delete;
2441 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2442 addr2->address_retry_key : addr2->domain_retry_key);
2443 *retry_key = 'T';
2444 retry_add_item(addr2, retry_key, flags);
2445 }
2446
2447 /* Done with this address */
2448
2449 if (result == OK) addr2->more_errno = deliver_time;
2450 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2451
2452 /* If a pipe delivery generated text to be sent back, the result may be
2453 changed to FAIL, and we must copy this for subsequent addresses in the
2454 batch. */
2455
2456 if (addr2->transport_return != result)
2457 {
2458 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2459 {
2460 addr3->transport_return = addr2->transport_return;
2461 addr3->basic_errno = addr2->basic_errno;
2462 addr3->message = addr2->message;
2463 }
2464 result = addr2->transport_return;
2465 }
2466
2467 /* Whether or not the result was changed to FAIL, we need to copy the
2468 return_file value from the first address into all the addresses of the
2469 batch, so they are all listed in the error message. */
2470
2471 addr2->return_file = addr->return_file;
2472
2473 /* Change log character for recording successful deliveries. */
2474
2475 if (result == OK) logchar = '-';
2476 }
2477 } /* Loop back for next batch of addresses */
2478 }
2479
2480
2481
2482
2483 /*************************************************
2484 * Sort remote deliveries *
2485 *************************************************/
2486
2487 /* This function is called if remote_sort_domains is set. It arranges that the
2488 chain of addresses for remote deliveries is ordered according to the strings
2489 specified. Try to make this shuffling reasonably efficient by handling
2490 sequences of addresses rather than just single ones.
2491
2492 Arguments: None
2493 Returns: Nothing
2494 */
2495
2496 static void
2497 sort_remote_deliveries(void)
2498 {
2499 int sep = 0;
2500 address_item **aptr = &addr_remote;
2501 uschar *listptr = remote_sort_domains;
2502 uschar *pattern;
2503 uschar patbuf[256];
2504
2505 while (*aptr != NULL &&
2506 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2507 != NULL)
2508 {
2509 address_item *moved = NULL;
2510 address_item **bptr = &moved;
2511
2512 while (*aptr != NULL)
2513 {
2514 address_item **next;
2515 deliver_domain = (*aptr)->domain; /* set $domain */
2516 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2517 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2518 {
2519 aptr = &((*aptr)->next);
2520 continue;
2521 }
2522
2523 next = &((*aptr)->next);
2524 while (*next != NULL &&
2525 (deliver_domain = (*next)->domain, /* Set $domain */
2526 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2527 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2528 next = &((*next)->next);
2529
2530 /* If the batch of non-matchers is at the end, add on any that were
2531 extracted further up the chain, and end this iteration. Otherwise,
2532 extract them from the chain and hang on the moved chain. */
2533
2534 if (*next == NULL)
2535 {
2536 *next = moved;
2537 break;
2538 }
2539
2540 *bptr = *aptr;
2541 *aptr = *next;
2542 *next = NULL;
2543 bptr = next;
2544 aptr = &((*aptr)->next);
2545 }
2546
2547 /* If the loop ended because the final address matched, *aptr will
2548 be NULL. Add on to the end any extracted non-matching addresses. If
2549 *aptr is not NULL, the loop ended via "break" when *next is null, that
2550 is, there was a string of non-matching addresses at the end. In this
2551 case the extracted addresses have already been added on the end. */
2552
2553 if (*aptr == NULL) *aptr = moved;
2554 }
2555
2556 DEBUG(D_deliver)
2557 {
2558 address_item *addr;
2559 debug_printf("remote addresses after sorting:\n");
2560 for (addr = addr_remote; addr != NULL; addr = addr->next)
2561 debug_printf(" %s\n", addr->address);
2562 }
2563 }
2564
2565
2566
2567 /*************************************************
2568 * Read from pipe for remote delivery subprocess *
2569 *************************************************/
2570
2571 /* This function is called when the subprocess is complete, but can also be
2572 called before it is complete, in order to empty a pipe that is full (to prevent
2573 deadlock). It must therefore keep track of its progress in the parlist data
2574 block.
2575
2576 We read the pipe to get the delivery status codes and a possible error message
2577 for each address, optionally preceded by unusability data for the hosts and
2578 also by optional retry data.
2579
2580 Read in large chunks into the big buffer and then scan through, interpreting
2581 the data therein. In most cases, only a single read will be necessary. No
2582 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2583 that we read the next chunk when there is less than 2500 bytes left in the
2584 non-final chunk, we can assume each item is complete in the buffer before
2585 handling it. Each item is written using a single write(), which is atomic for
2586 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2587 often bigger) so even if we are reading while the subprocess is still going, we
2588 should never have only a partial item in the buffer.
2589
2590 Argument:
2591 poffset the offset of the parlist item
2592 eop TRUE if the process has completed
2593
2594 Returns: TRUE if the terminating 'Z' item has been read,
2595 or there has been a disaster (i.e. no more data needed);
2596 FALSE otherwise
2597 */
2598
2599 static BOOL
2600 par_read_pipe(int poffset, BOOL eop)
2601 {
2602 host_item *h;
2603 pardata *p = parlist + poffset;
2604 address_item *addrlist = p->addrlist;
2605 address_item *addr = p->addr;
2606 pid_t pid = p->pid;
2607 int fd = p->fd;
2608 uschar *endptr = big_buffer;
2609 uschar *ptr = endptr;
2610 uschar *msg = p->msg;
2611 BOOL done = p->done;
2612 BOOL unfinished = TRUE;
2613
2614 /* Loop through all items, reading from the pipe when necessary. The pipe
2615 is set up to be non-blocking, but there are two different Unix mechanisms in
2616 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2617 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2618 which returns 0 for both end of file and no more data. We distinguish the
2619 two cases by taking 0 as end of file only when we know the process has
2620 completed.
2621
2622 Each separate item is written to the pipe in a single write(), and as they are
2623 all short items, the writes will all be atomic and we should never find
2624 ourselves in the position of having read an incomplete item. "Short" in this
2625 case can mean up to about 1K in the case when there is a long error message
2626 associated with an address. */
2627
2628 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2629 (int)p->pid, eop? "ended" : "not ended");
2630
2631 while (!done)
2632 {
2633 retry_item *r, **rp;
2634 int remaining = endptr - ptr;
2635
2636 /* Read (first time) or top up the chars in the buffer if necessary.
2637 There will be only one read if we get all the available data (i.e. don't
2638 fill the buffer completely). */
2639
2640 if (remaining < 2500 && unfinished)
2641 {
2642 int len;
2643 int available = big_buffer_size - remaining;
2644
2645 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2646
2647 ptr = big_buffer;
2648 endptr = big_buffer + remaining;
2649 len = read(fd, endptr, available);
2650
2651 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2652
2653 /* If the result is EAGAIN and the process is not complete, just
2654 stop reading any more and process what we have already. */
2655
2656 if (len < 0)
2657 {
2658 if (!eop && errno == EAGAIN) len = 0; else
2659 {
2660 msg = string_sprintf("failed to read pipe from transport process "
2661 "%d for transport %s: %s", pid, addr->transport->driver_name,
2662 strerror(errno));
2663 break;
2664 }
2665 }
2666
2667 /* If the length is zero (eof or no-more-data), just process what we
2668 already have. Note that if the process is still running and we have
2669 read all the data in the pipe (but less that "available") then we
2670 won't read any more, as "unfinished" will get set FALSE. */
2671
2672 endptr += len;
2673 unfinished = len == available;
2674 }
2675
2676 /* If we are at the end of the available data, exit the loop. */
2677
2678 if (ptr >= endptr) break;
2679
2680 /* Handle each possible type of item, assuming the complete item is
2681 available in store. */
2682
2683 switch (*ptr++)
2684 {
2685 /* Host items exist only if any hosts were marked unusable. Match
2686 up by checking the IP address. */
2687
2688 case 'H':
2689 for (h = addrlist->host_list; h != NULL; h = h->next)
2690 {
2691 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2692 h->status = ptr[0];
2693 h->why = ptr[1];
2694 }
2695 ptr += 2;
2696 while (*ptr++);
2697 break;
2698
2699 /* Retry items are sent in a preceding R item for each address. This is
2700 kept separate to keep each message short enough to guarantee it won't
2701 be split in the pipe. Hopefully, in the majority of cases, there won't in
2702 fact be any retry items at all.
2703
2704 The complete set of retry items might include an item to delete a
2705 routing retry if there was a previous routing delay. However, routing
2706 retries are also used when a remote transport identifies an address error.
2707 In that case, there may also be an "add" item for the same key. Arrange
2708 that a "delete" item is dropped in favour of an "add" item. */
2709
2710 case 'R':
2711 if (addr == NULL) goto ADDR_MISMATCH;
2712
2713 DEBUG(D_deliver|D_retry)
2714 debug_printf("reading retry information for %s from subprocess\n",
2715 ptr+1);
2716
2717 /* Cut out any "delete" items on the list. */
2718
2719 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2720 {
2721 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2722 {
2723 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2724 *rp = r->next; /* Excise a delete item */
2725 DEBUG(D_deliver|D_retry)
2726 debug_printf(" existing delete item dropped\n");
2727 }
2728 }
2729
2730 /* We want to add a delete item only if there is no non-delete item;
2731 however we still have to step ptr through the data. */
2732
2733 if (r == NULL || (*ptr & rf_delete) == 0)
2734 {
2735 r = store_get(sizeof(retry_item));
2736 r->next = addr->retries;
2737 addr->retries = r;
2738 r->flags = *ptr++;
2739 r->key = string_copy(ptr);
2740 while (*ptr++);
2741 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2742 ptr += sizeof(r->basic_errno);
2743 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2744 ptr += sizeof(r->more_errno);
2745 r->message = (*ptr)? string_copy(ptr) : NULL;
2746 DEBUG(D_deliver|D_retry)
2747 debug_printf(" added %s item\n",
2748 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2749 }
2750
2751 else
2752 {
2753 DEBUG(D_deliver|D_retry)
2754 debug_printf(" delete item not added: non-delete item exists\n");
2755 ptr++;
2756 while(*ptr++);
2757 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2758 }
2759
2760 while(*ptr++);
2761 break;
2762
2763 /* Put the amount of data written into the parlist block */
2764
2765 case 'S':
2766 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2767 ptr += sizeof(transport_count);
2768 break;
2769
2770 /* Address items are in the order of items on the address chain. We
2771 remember the current address value in case this function is called
2772 several times to empty the pipe in stages. Information about delivery
2773 over TLS is sent in a preceding X item for each address. We don't put
2774 it in with the other info, in order to keep each message short enough to
2775 guarantee it won't be split in the pipe. */
2776
2777 #ifdef SUPPORT_TLS
2778 case 'X':
2779 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2780 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2781 while (*ptr++);
2782 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2783 while (*ptr++);
2784 break;
2785 #endif
2786
2787 case 'A':
2788 if (addr == NULL)
2789 {
2790 ADDR_MISMATCH:
2791 msg = string_sprintf("address count mismatch for data read from pipe "
2792 "for transport process %d for transport %s", pid,
2793 addrlist->transport->driver_name);
2794 done = TRUE;
2795 break;
2796 }
2797
2798 addr->transport_return = *ptr++;
2799 addr->special_action = *ptr++;
2800 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2801 ptr += sizeof(addr->basic_errno);
2802 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2803 ptr += sizeof(addr->more_errno);
2804 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2805 ptr += sizeof(addr->flags);
2806 addr->message = (*ptr)? string_copy(ptr) : NULL;
2807 while(*ptr++);
2808 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2809 while(*ptr++);
2810
2811 /* Always two strings for host information, followed by the port number */
2812
2813 if (*ptr != 0)
2814 {
2815 h = store_get(sizeof(host_item));
2816 h->name = string_copy(ptr);
2817 while (*ptr++);
2818 h->address = string_copy(ptr);
2819 while(*ptr++);
2820 memcpy(&(h->port), ptr, sizeof(h->port));
2821 ptr += sizeof(h->port);
2822 addr->host_used = h;
2823 }
2824 else ptr++;
2825
2826 /* Finished with this address */
2827
2828 addr = addr->next;
2829 break;
2830
2831 /* Z marks the logical end of the data. It is followed by '0' if
2832 continue_transport was NULL at the end of transporting, otherwise '1'.
2833 We need to know when it becomes NULL during a delivery down a passed SMTP
2834 channel so that we don't try to pass anything more down it. Of course, for
2835 most normal messages it will remain NULL all the time. */
2836
2837 case 'Z':
2838 if (*ptr == '0')
2839 {
2840 continue_transport = NULL;
2841 continue_hostname = NULL;
2842 }
2843 done = TRUE;
2844 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
2845 break;
2846
2847 /* Anything else is a disaster. */
2848
2849 default:
2850 msg = string_sprintf("malformed data (%d) read from pipe for transport "
2851 "process %d for transport %s", ptr[-1], pid,
2852 addr->transport->driver_name);
2853 done = TRUE;
2854 break;
2855 }
2856 }
2857
2858 /* The done flag is inspected externally, to determine whether or not to
2859 call the function again when the process finishes. */
2860
2861 p->done = done;
2862
2863 /* If the process hadn't finished, and we haven't seen the end of the data
2864 or suffered a disaster, update the rest of the state, and return FALSE to
2865 indicate "not finished". */
2866
2867 if (!eop && !done)
2868 {
2869 p->addr = addr;
2870 p->msg = msg;
2871 return FALSE;
2872 }
2873
2874 /* Close our end of the pipe, to prevent deadlock if the far end is still
2875 pushing stuff into it. */
2876
2877 close(fd);
2878 p->fd = -1;
2879
2880 /* If we have finished without error, but haven't had data for every address,
2881 something is wrong. */
2882
2883 if (msg == NULL && addr != NULL)
2884 msg = string_sprintf("insufficient address data read from pipe "
2885 "for transport process %d for transport %s", pid,
2886 addr->transport->driver_name);
2887
2888 /* If an error message is set, something has gone wrong in getting back
2889 the delivery data. Put the message into each address and freeze it. */
2890
2891 if (msg != NULL)
2892 {
2893 for (addr = addrlist; addr != NULL; addr = addr->next)
2894 {
2895 addr->transport_return = DEFER;
2896 addr->special_action = SPECIAL_FREEZE;
2897 addr->message = msg;
2898 }
2899 }
2900
2901 /* Return TRUE to indicate we have got all we need from this process, even
2902 if it hasn't actually finished yet. */
2903
2904 return TRUE;
2905 }
2906
2907
2908
2909 /*************************************************
2910 * Post-process a set of remote addresses *
2911 *************************************************/
2912
2913 /* Do what has to be done immediately after a remote delivery for each set of
2914 addresses, then re-write the spool if necessary. Note that post_process_one
2915 puts the address on an appropriate queue; hence we must fish off the next
2916 one first. This function is also called if there is a problem with setting
2917 up a subprocess to do a remote delivery in parallel. In this case, the final
2918 argument contains a message, and the action must be forced to DEFER.
2919
2920 Argument:
2921 addr pointer to chain of address items
2922 logflags flags for logging
2923 msg NULL for normal cases; -> error message for unexpected problems
2924 fallback TRUE if processing fallback hosts
2925
2926 Returns: nothing
2927 */
2928
2929 static void
2930 remote_post_process(address_item *addr, int logflags, uschar *msg,
2931 BOOL fallback)
2932 {
2933 host_item *h;
2934
2935 /* If any host addresses were found to be unusable, add them to the unusable
2936 tree so that subsequent deliveries don't try them. */
2937
2938 for (h = addr->host_list; h != NULL; h = h->next)
2939 {
2940 if (h->address == NULL) continue;
2941 if (h->status >= hstatus_unusable) tree_add_unusable(h);
2942 }
2943
2944 /* Now handle each address on the chain. The transport has placed '=' or '-'
2945 into the special_action field for each successful delivery. */
2946
2947 while (addr != NULL)
2948 {
2949 address_item *next = addr->next;
2950
2951 /* If msg == NULL (normal processing) and the result is DEFER and we are
2952 processing the main hosts and there are fallback hosts available, put the
2953 address on the list for fallback delivery. */
2954
2955 if (addr->transport_return == DEFER &&
2956 addr->fallback_hosts != NULL &&
2957 !fallback &&
2958 msg == NULL)
2959 {
2960 addr->host_list = addr->fallback_hosts;
2961 addr->next = addr_fallback;
2962 addr_fallback = addr;
2963 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
2964 }
2965
2966 /* If msg is set (=> unexpected problem), set it in the address before
2967 doing the ordinary post processing. */
2968
2969 else
2970 {
2971 if (msg != NULL)
2972 {
2973 addr->message = msg;
2974 addr->transport_return = DEFER;
2975 }
2976 (void)post_process_one(addr, addr->transport_return, logflags,
2977 DTYPE_TRANSPORT, addr->special_action);
2978 }
2979
2980 /* Next address */
2981
2982 addr = next;
2983 }
2984
2985 /* If we have just delivered down a passed SMTP channel, and that was
2986 the last address, the channel will have been closed down. Now that
2987 we have logged that delivery, set continue_sequence to 1 so that
2988 any subsequent deliveries don't get "*" incorrectly logged. */
2989
2990 if (continue_transport == NULL) continue_sequence = 1;
2991 }
2992
2993
2994
2995 /*************************************************
2996 * Wait for one remote delivery subprocess *
2997 *************************************************/
2998
2999 /* This function is called while doing remote deliveries when either the
3000 maximum number of processes exist and we need one to complete so that another
3001 can be created, or when waiting for the last ones to complete. It must wait for
3002 the completion of one subprocess, empty the control block slot, and return a
3003 pointer to the address chain.
3004
3005 Arguments: none
3006 Returns: pointer to the chain of addresses handled by the process;
3007 NULL if no subprocess found - this is an unexpected error
3008 */
3009
3010 static address_item *
3011 par_wait(void)
3012 {
3013 int poffset, status;
3014 address_item *addr, *addrlist;
3015 pid_t pid;
3016
3017 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3018 "to finish", message_id);
3019
3020 /* Loop until either a subprocess completes, or there are no subprocesses in
3021 existence - in which case give an error return. We cannot proceed just by
3022 waiting for a completion, because a subprocess may have filled up its pipe, and
3023 be waiting for it to be emptied. Therefore, if no processes have finished, we
3024 wait for one of the pipes to acquire some data by calling select(), with a
3025 timeout just in case.
3026
3027 The simple approach is just to iterate after reading data from a ready pipe.
3028 This leads to non-ideal behaviour when the subprocess has written its final Z
3029 item, closed the pipe, and is in the process of exiting (the common case). A
3030 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3031 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3032 actually finished.
3033
3034 To avoid this, if all the data that is needed has been read from a subprocess
3035 after select(), an explicit wait() for it is done. We know that all it is doing
3036 is writing to the pipe and then exiting, so the wait should not be long.
3037
3038 The non-blocking waitpid() is to some extent just insurance; if we could
3039 reliably detect end-of-file on the pipe, we could always know when to do a
3040 blocking wait() for a completed process. However, because some systems use
3041 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3042 use code that functions without the need to recognize EOF.
3043
3044 There's a double loop here just in case we end up with a process that is not in
3045 the list of remote delivery processes. Something has obviously gone wrong if
3046 this is the case. (For example, a process that is incorrectly left over from
3047 routing or local deliveries might be found.) The damage can be minimized by
3048 looping back and looking for another process. If there aren't any, the error
3049 return will happen. */
3050
3051 for (;;) /* Normally we do not repeat this loop */
3052 {
3053 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3054 {
3055 struct timeval tv;
3056 fd_set select_pipes;
3057 int maxpipe, readycount;
3058
3059 /* A return value of -1 can mean several things. If errno != ECHILD, it
3060 either means invalid options (which we discount), or that this process was
3061 interrupted by a signal. Just loop to try the waitpid() again.
3062
3063 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3064 in existence. This should never happen, and is an unexpected error.
3065 However, there is a nasty complication when running under Linux. If "strace
3066 -f" is being used under Linux to trace this process and its children,
3067 subprocesses are "stolen" from their parents and become the children of the
3068 tracing process. A general wait such as the one we've just obeyed returns
3069 as if there are no children while subprocesses are running. Once a
3070 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3071 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3072 palliative.
3073
3074 This does not happen using "truss" on Solaris, nor (I think) with other
3075 tracing facilities on other OS. It seems to be specific to Linux.
3076
3077 What we do to get round this is to use kill() to see if any of our
3078 subprocesses are still in existence. If kill() gives an OK return, we know
3079 it must be for one of our processes - it can't be for a re-use of the pid,
3080 because if our process had finished, waitpid() would have found it. If any
3081 of our subprocesses are in existence, we proceed to use select() as if
3082 waitpid() had returned zero. I think this is safe. */
3083
3084 if (pid < 0)
3085 {
3086 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3087
3088 DEBUG(D_deliver)
3089 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3090 "for process existence\n");
3091
3092 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3093 {
3094 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3095 {
3096 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3097 "stolen by strace\n", (int)pid);
3098 break; /* With poffset set */
3099 }
3100 }
3101
3102 if (poffset >= remote_max_parallel)
3103 {
3104 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3105 return NULL; /* This is the error return */
3106 }
3107 }
3108
3109 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3110 been handled above. A return value of zero means that there is at least one
3111 subprocess, but there are no completed subprocesses. See if any pipes are
3112 ready with any data for reading. */
3113
3114 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3115
3116 maxpipe = 0;
3117 FD_ZERO(&select_pipes);
3118 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3119 {
3120 if (parlist[poffset].pid != 0)
3121 {
3122 int fd = parlist[poffset].fd;
3123 FD_SET(fd, &select_pipes);
3124 if (fd > maxpipe) maxpipe = fd;
3125 }
3126 }
3127
3128 /* Stick in a 60-second timeout, just in case. */
3129
3130 tv.tv_sec = 60;
3131 tv.tv_usec = 0;
3132
3133 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3134 NULL, NULL, &tv);
3135
3136 /* Scan through the pipes and read any that are ready; use the count
3137 returned by select() to stop when there are no more. Select() can return
3138 with no processes (e.g. if interrupted). This shouldn't matter.
3139
3140 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3141 read, or there was a disaster. In either case, we are finished with this
3142 process. Do an explicit wait() for the process and break the main loop if
3143 it succeeds.
3144
3145 It turns out that we have to deal with the case of an interrupted system
3146 call, which can happen on some operating systems if the signal handling is
3147 set up to do that by default. */
3148
3149 for (poffset = 0;
3150 readycount > 0 && poffset < remote_max_parallel;
3151 poffset++)
3152 {
3153 if ((pid = parlist[poffset].pid) != 0 &&
3154 FD_ISSET(parlist[poffset].fd, &select_pipes))
3155 {
3156 readycount--;
3157 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3158 {
3159 for (;;) /* Loop for signals */
3160 {
3161 pid_t endedpid = waitpid(pid, &status, 0);
3162 if (endedpid == pid) goto PROCESS_DONE;
3163 if (endedpid != (pid_t)(-1) || errno != EINTR)
3164 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3165 "%d (errno = %d) from waitpid() for process %d",
3166 (int)endedpid, errno, (int)pid);
3167 }
3168 }
3169 }
3170 }
3171
3172 /* Now go back and look for a completed subprocess again. */
3173 }
3174
3175 /* A completed process was detected by the non-blocking waitpid(). Find the
3176 data block that corresponds to this subprocess. */
3177
3178 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3179 if (pid == parlist[poffset].pid) break;
3180
3181 /* Found the data block; this is a known remote delivery process. We don't
3182 need to repeat the outer loop. This should be what normally happens. */
3183
3184 if (poffset < remote_max_parallel) break;
3185
3186 /* This situation is an error, but it's probably better to carry on looking
3187 for another process than to give up (as we used to do). */
3188
3189 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3190 "transport process list", pid);
3191 } /* End of the "for" loop */
3192
3193 /* Come here when all the data was completely read after a select(), and
3194 the process in pid has been wait()ed for. */
3195
3196 PROCESS_DONE:
3197
3198 DEBUG(D_deliver)
3199 {
3200 if (status == 0)
3201 debug_printf("remote delivery process %d ended\n", (int)pid);
3202 else
3203 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3204 status);
3205 }
3206
3207 set_process_info("delivering %s", message_id);
3208
3209 /* Get the chain of processed addresses */
3210
3211 addrlist = parlist[poffset].addrlist;
3212
3213 /* If the process did not finish cleanly, record an error and freeze (except
3214 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3215 in case the delivery did actually happen. */
3216
3217 if ((status & 0xffff) != 0)
3218 {
3219 uschar *msg;
3220 int msb = (status >> 8) & 255;
3221 int lsb = status & 255;
3222 int code = (msb == 0)? (lsb & 0x7f) : msb;
3223
3224 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3225 "%s %d",
3226 addrlist->transport->driver_name,
3227 status,
3228 (msb == 0)? "terminated by signal" : "exit code",
3229 code);
3230
3231 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3232 addrlist->special_action = SPECIAL_FREEZE;
3233
3234 for (addr = addrlist; addr != NULL; addr = addr->next)
3235 {
3236 addr->transport_return = DEFER;
3237 addr->message = msg;
3238 }
3239
3240 remove_journal = FALSE;
3241 }
3242
3243 /* Else complete reading the pipe to get the result of the delivery, if all
3244 the data has not yet been obtained. */
3245
3246 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3247
3248 /* Put the data count and return path into globals, mark the data slot unused,
3249 decrement the count of subprocesses, and return the address chain. */
3250
3251 transport_count = parlist[poffset].transport_count;
3252 used_return_path = parlist[poffset].return_path;
3253 parlist[poffset].pid = 0;
3254 parcount--;
3255 return addrlist;
3256 }
3257
3258
3259
3260 /*************************************************
3261 * Wait for subprocesses and post-process *
3262 *************************************************/
3263
3264 /* This function waits for subprocesses until the number that are still running
3265 is below a given threshold. For each complete subprocess, the addresses are
3266 post-processed. If we can't find a running process, there is some shambles.
3267 Better not bomb out, as that might lead to multiple copies of the message. Just
3268 log and proceed as if all done.
3269
3270 Arguments:
3271 max maximum number of subprocesses to leave running
3272 fallback TRUE if processing fallback hosts
3273
3274 Returns: nothing
3275 */
3276
3277 static void
3278 par_reduce(int max, BOOL fallback)
3279 {
3280 while (parcount > max)
3281 {
3282 address_item *doneaddr = par_wait();
3283 if (doneaddr == NULL)
3284 {
3285 log_write(0, LOG_MAIN|LOG_PANIC,
3286 "remote delivery process count got out of step");
3287 parcount = 0;
3288 }
3289 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3290 }
3291 }
3292
3293
3294
3295
3296 /*************************************************
3297 * Do remote deliveries *
3298 *************************************************/
3299
3300 /* This function is called to process the addresses in addr_remote. We must
3301 pick off the queue all addresses that have the same transport, remote
3302 destination, and errors address, and hand them to the transport in one go,
3303 subject to some configured limitations. If this is a run to continue delivering
3304 to an existing delivery channel, skip all but those addresses that can go to
3305 that channel. The skipped addresses just get deferred.
3306
3307 If mua_wrapper is set, all addresses must be able to be sent in a single
3308 transaction. If not, this function yields FALSE.
3309
3310 In Exim 4, remote deliveries are always done in separate processes, even
3311 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3312 is so that the base process can retain privilege. This makes the
3313 implementation of fallback transports feasible (though not initially done.)
3314
3315 We create up to the configured number of subprocesses, each of which passes
3316 back the delivery state via a pipe. (However, when sending down an existing
3317 connection, remote_max_parallel is forced to 1.)
3318
3319 Arguments:
3320 fallback TRUE if processing fallback hosts
3321
3322 Returns: TRUE normally
3323 FALSE if mua_wrapper is set and the addresses cannot all be sent
3324 in one transaction
3325 */
3326
3327 static BOOL
3328 do_remote_deliveries(BOOL fallback)
3329 {
3330 int parmax;
3331 int delivery_count;
3332 int poffset;
3333
3334 parcount = 0; /* Number of executing subprocesses */
3335
3336 /* When sending down an existing channel, only do one delivery at a time.
3337 We use a local variable (parmax) to hold the maximum number of processes;
3338 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3339
3340 if (continue_transport != NULL) remote_max_parallel = 1;
3341 parmax = remote_max_parallel;
3342
3343 /* If the data for keeping a list of processes hasn't yet been
3344 set up, do so. */
3345
3346 if (parlist == NULL)
3347 {
3348 parlist = store_get(remote_max_parallel * sizeof(pardata));
3349 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3350 parlist[poffset].pid = 0;
3351 }
3352
3353 /* Now loop for each remote delivery */
3354
3355 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3356 {
3357 pid_t pid;
3358 uid_t uid;
3359 gid_t gid;
3360 int pfd[2];
3361 int address_count = 1;
3362 int address_count_max;
3363 BOOL multi_domain;
3364 BOOL use_initgroups;
3365 BOOL pipe_done = FALSE;
3366 transport_instance *tp;
3367 address_item **anchor = &addr_remote;
3368 address_item *addr = addr_remote;
3369 address_item *last = addr;
3370 address_item *next;
3371
3372 /* Pull the first address right off the list. */
3373
3374 addr_remote = addr->next;
3375 addr->next = NULL;
3376
3377 DEBUG(D_deliver|D_transport)
3378 debug_printf("--------> %s <--------\n", addr->address);
3379
3380 /* If no transport has been set, there has been a big screw-up somewhere. */
3381
3382 if ((tp = addr->transport) == NULL)
3383 {
3384 disable_logging = FALSE; /* Jic */
3385 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3386 US"No transport set by router", fallback);
3387 continue;
3388 }
3389
3390 /* Check that this base address hasn't previously been delivered to this
3391 transport. The check is necessary at this point to handle homonymic addresses
3392 correctly in cases where the pattern of redirection changes between delivery
3393 attempts. Non-homonymic previous delivery is detected earlier, at routing
3394 time. */
3395
3396 if (previously_transported(addr, FALSE)) continue;
3397
3398 /* Force failure if the message is too big. */
3399
3400 if (tp->message_size_limit != NULL)
3401 {
3402 int rc = check_message_size(tp, addr);
3403 if (rc != OK)
3404 {
3405 addr->transport_return = rc;
3406 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3407 continue;
3408 }
3409 }
3410
3411 /* Get the flag which specifies whether the transport can handle different
3412 domains that nevertheless resolve to the same set of hosts. */
3413
3414 multi_domain = tp->multi_domain;
3415
3416 /* Get the maximum it can handle in one envelope, with zero meaning
3417 unlimited, which is forced for the MUA wrapper case. */
3418
3419 address_count_max = tp->max_addresses;
3420 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3421
3422
3423 /************************************************************************/
3424 /***** This is slightly experimental code, but should be safe. *****/
3425
3426 /* The address_count_max value is the maximum number of addresses that the
3427 transport can send in one envelope. However, the transport must be capable of
3428 dealing with any number of addresses. If the number it gets exceeds its
3429 envelope limitation, it must send multiple copies of the message. This can be
3430 done over a single connection for SMTP, so uses less resources than making
3431 multiple connections. On the other hand, if remote_max_parallel is greater
3432 than one, it is perhaps a good idea to use parallel processing to move the
3433 message faster, even if that results in multiple simultaneous connections to
3434 the same host.
3435
3436 How can we come to some compromise between these two ideals? What we do is to
3437 limit the number of addresses passed to a single instance of a transport to
3438 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3439 number of addresses routed to remote transports divided by
3440 remote_max_parallel. For example, if the message has 100 remote recipients,
3441 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3442 once. But if rcpt_max is 100, we could send up to 100.
3443
3444 Of course, not all the remotely addresses in a message are going to go to the
3445 same set of hosts (except in smarthost configurations), so this is just a
3446 heuristic way of dividing up the work.
3447
3448 Furthermore (1), because this may not be wanted in some cases, and also to
3449 cope with really pathological cases, there is also a limit to the number of