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