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