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