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