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