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