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