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