1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
12 #include "transports/smtp.h"
17 /* Data block for keeping track of subprocesses for parallel remote
20 typedef struct pardata
{
21 address_item
*addrlist
; /* chain of addresses */
22 address_item
*addr
; /* next address data expected for */
23 pid_t pid
; /* subprocess pid */
24 int fd
; /* pipe fd for getting result from subprocess */
25 int transport_count
; /* returned transport count value */
26 BOOL done
; /* no more data needed */
27 uschar
*msg
; /* error message */
28 uschar
*return_path
; /* return_path for these addresses */
31 /* Values for the process_recipients variable */
33 enum { RECIP_ACCEPT
, RECIP_IGNORE
, RECIP_DEFER
,
34 RECIP_FAIL
, RECIP_FAIL_FILTER
, RECIP_FAIL_TIMEOUT
,
37 /* Mutually recursive functions for marking addresses done. */
39 static void child_done(address_item
*, uschar
*);
40 static void address_done(address_item
*, uschar
*);
42 /* Table for turning base-62 numbers into binary */
44 static uschar tab62
[] =
45 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
46 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
47 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
48 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
49 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
50 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
54 /*************************************************
55 * Local static variables *
56 *************************************************/
58 /* addr_duplicate is global because it needs to be seen from the Envelope-To
61 static address_item
*addr_defer
= NULL
;
62 static address_item
*addr_failed
= NULL
;
63 static address_item
*addr_fallback
= NULL
;
64 static address_item
*addr_local
= NULL
;
65 static address_item
*addr_new
= NULL
;
66 static address_item
*addr_remote
= NULL
;
67 static address_item
*addr_route
= NULL
;
68 static address_item
*addr_succeed
= NULL
;
69 static address_item
*addr_senddsn
= NULL
;
71 static FILE *message_log
= NULL
;
72 static BOOL update_spool
;
73 static BOOL remove_journal
;
74 static int parcount
= 0;
75 static pardata
*parlist
= NULL
;
76 static int return_count
;
77 static uschar
*frozen_info
= US
"";
78 static uschar
*used_return_path
= NULL
;
82 /*************************************************
83 * read as much as requested *
84 *************************************************/
86 /* The syscall read(2) doesn't always returns as much as we want. For
87 several reasons it might get less. (Not talking about signals, as syscalls
88 are restartable). When reading from a network or pipe connection the sender
89 might send in smaller chunks, with delays between these chunks. The read(2)
90 may return such a chunk.
92 The more the writer writes and the smaller the pipe between write and read is,
93 the more we get the chance of reading leass than requested. (See bug 2130)
95 This function read(2)s until we got all the data we *requested*.
97 Note: This function may block. Use it only if you're sure about the
98 amount of data you will get.
101 fd the file descriptor to read from
102 buffer pointer to a buffer of size len
103 len the requested(!) amount of bytes
105 Returns: the amount of bytes read
108 readn(int fd
, void * buffer
, size_t len
)
110 uschar
* next
= buffer
;
111 uschar
* end
= next
+ len
;
115 ssize_t got
= read(fd
, next
, end
- next
);
117 /* I'm not sure if there are signals that can interrupt us,
118 for now I assume the worst */
119 if (got
== -1 && errno
== EINTR
) continue;
120 if (got
<= 0) return next
- US buffer
;
128 /*************************************************
129 * Make a new address item *
130 *************************************************/
132 /* This function gets the store and initializes with default values. The
133 transport_return value defaults to DEFER, so that any unexpected failure to
134 deliver does not wipe out the message. The default unique string is set to a
135 copy of the address, so that its domain can be lowercased.
138 address the RFC822 address string
139 copy force a copy of the address
141 Returns: a pointer to an initialized address_item
145 deliver_make_addr(uschar
*address
, BOOL copy
)
147 address_item
*addr
= store_get(sizeof(address_item
), FALSE
);
148 *addr
= address_defaults
;
149 if (copy
) address
= string_copy(address
);
150 addr
->address
= address
;
151 addr
->unique
= string_copy(address
);
158 /*************************************************
159 * Set expansion values for an address *
160 *************************************************/
162 /* Certain expansion variables are valid only when handling an address or
163 address list. This function sets them up or clears the values, according to its
167 addr the address in question, or NULL to clear values
172 deliver_set_expansions(address_item
*addr
)
176 const uschar
***p
= address_expansions
;
177 while (*p
) **p
++ = NULL
;
181 /* Exactly what gets set depends on whether there is one or more addresses, and
182 what they contain. These first ones are always set, taking their values from
183 the first address. */
185 if (!addr
->host_list
)
187 deliver_host
= deliver_host_address
= US
"";
188 deliver_host_port
= 0;
192 deliver_host
= addr
->host_list
->name
;
193 deliver_host_address
= addr
->host_list
->address
;
194 deliver_host_port
= addr
->host_list
->port
;
197 deliver_recipients
= addr
;
198 deliver_address_data
= addr
->prop
.address_data
;
199 deliver_domain_data
= addr
->prop
.domain_data
;
200 deliver_localpart_data
= addr
->prop
.localpart_data
;
201 router_var
= addr
->prop
.variables
;
203 /* These may be unset for multiple addresses */
205 deliver_domain
= addr
->domain
;
206 self_hostname
= addr
->self_hostname
;
208 #ifdef EXPERIMENTAL_BRIGHTMAIL
209 bmi_deliver
= 1; /* deliver by default */
210 bmi_alt_location
= NULL
;
211 bmi_base64_verdict
= NULL
;
212 bmi_base64_tracker_verdict
= NULL
;
215 /* If there's only one address we can set everything. */
219 address_item
*addr_orig
;
221 deliver_localpart
= addr
->local_part
;
222 deliver_localpart_prefix
= addr
->prefix
;
223 deliver_localpart_suffix
= addr
->suffix
;
225 for (addr_orig
= addr
; addr_orig
->parent
; addr_orig
= addr_orig
->parent
) ;
226 deliver_domain_orig
= addr_orig
->domain
;
228 /* Re-instate any prefix and suffix in the original local part. In all
229 normal cases, the address will have a router associated with it, and we can
230 choose the caseful or caseless version accordingly. However, when a system
231 filter sets up a pipe, file, or autoreply delivery, no router is involved.
232 In this case, though, there won't be any prefix or suffix to worry about. */
234 deliver_localpart_orig
= !addr_orig
->router
235 ? addr_orig
->local_part
236 : addr_orig
->router
->caseful_local_part
237 ? addr_orig
->cc_local_part
238 : addr_orig
->lc_local_part
;
240 /* If there's a parent, make its domain and local part available, and if
241 delivering to a pipe or file, or sending an autoreply, get the local
242 part from the parent. For pipes and files, put the pipe or file string
243 into address_pipe and address_file. */
247 deliver_domain_parent
= addr
->parent
->domain
;
248 deliver_localpart_parent
= !addr
->parent
->router
249 ? addr
->parent
->local_part
250 : addr
->parent
->router
->caseful_local_part
251 ? addr
->parent
->cc_local_part
252 : addr
->parent
->lc_local_part
;
254 /* File deliveries have their own flag because they need to be picked out
255 as special more often. */
257 if (testflag(addr
, af_pfr
))
259 if (testflag(addr
, af_file
)) address_file
= addr
->local_part
;
260 else if (deliver_localpart
[0] == '|') address_pipe
= addr
->local_part
;
261 deliver_localpart
= addr
->parent
->local_part
;
262 deliver_localpart_prefix
= addr
->parent
->prefix
;
263 deliver_localpart_suffix
= addr
->parent
->suffix
;
267 #ifdef EXPERIMENTAL_BRIGHTMAIL
268 /* Set expansion variables related to Brightmail AntiSpam */
269 bmi_base64_verdict
= bmi_get_base64_verdict(deliver_localpart_orig
, deliver_domain_orig
);
270 bmi_base64_tracker_verdict
= bmi_get_base64_tracker_verdict(bmi_base64_verdict
);
271 /* get message delivery status (0 - don't deliver | 1 - deliver) */
272 bmi_deliver
= bmi_get_delivery_status(bmi_base64_verdict
);
273 /* if message is to be delivered, get eventual alternate location */
274 if (bmi_deliver
== 1)
275 bmi_alt_location
= bmi_get_alt_location(bmi_base64_verdict
);
280 /* For multiple addresses, don't set local part, and leave the domain and
281 self_hostname set only if it is the same for all of them. It is possible to
282 have multiple pipe and file addresses, but only when all addresses have routed
283 to the same pipe or file. */
287 if (testflag(addr
, af_pfr
))
289 if (testflag(addr
, af_file
)) address_file
= addr
->local_part
;
290 else if (addr
->local_part
[0] == '|') address_pipe
= addr
->local_part
;
292 for (address_item
* addr2
= addr
->next
; addr2
; addr2
= addr2
->next
)
294 if (deliver_domain
&& Ustrcmp(deliver_domain
, addr2
->domain
) != 0)
295 deliver_domain
= NULL
;
297 && ( !addr2
->self_hostname
298 || Ustrcmp(self_hostname
, addr2
->self_hostname
) != 0
300 self_hostname
= NULL
;
301 if (!deliver_domain
&& !self_hostname
) break;
309 /*************************************************
310 * Open a msglog file *
311 *************************************************/
313 /* This function is used both for normal message logs, and for files in the
314 msglog directory that are used to catch output from pipes. Try to create the
315 directory if it does not exist. From release 4.21, normal message logs should
316 be created when the message is received.
318 Called from deliver_message(), can be operating as root.
321 filename the file name
322 mode the mode required
323 error used for saying what failed
325 Returns: a file descriptor, or -1 (with errno set)
329 open_msglog_file(uschar
*filename
, int mode
, uschar
**error
)
331 if (Ustrstr(filename
, US
"/../"))
332 log_write(0, LOG_MAIN
|LOG_PANIC
,
333 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename
);
335 for (int i
= 2; i
> 0; i
--)
337 int fd
= Uopen(filename
,
344 O_WRONLY
|O_APPEND
|O_CREAT
, mode
);
347 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
348 function is called as root). Double check the mode, because the group setting
349 doesn't always get set automatically. */
352 (void)fcntl(fd
, F_SETFD
, fcntl(fd
, F_GETFD
) | FD_CLOEXEC
);
354 if (exim_fchown(fd
, exim_uid
, exim_gid
, filename
) < 0)
359 if (fchmod(fd
, mode
) < 0)
369 (void)directory_make(spool_directory
,
370 spool_sname(US
"msglog", message_subdir
),
371 MSGLOG_DIRECTORY_MODE
, TRUE
);
374 *error
= US
"create or open";
381 /*************************************************
382 * Write to msglog if required *
383 *************************************************/
385 /* Write to the message log, if configured. This function may also be called
389 format a string format
395 deliver_msglog(const char *format
, ...)
398 if (!message_logs
) return;
399 va_start(ap
, format
);
400 vfprintf(message_log
, format
, ap
);
408 /*************************************************
409 * Replicate status for batch *
410 *************************************************/
412 /* When a transport handles a batch of addresses, it may treat them
413 individually, or it may just put the status in the first one, and return FALSE,
414 requesting that the status be copied to all the others externally. This is the
415 replication function. As well as the status, it copies the transport pointer,
416 which may have changed if appendfile passed the addresses on to a different
419 Argument: pointer to the first address in a chain
424 replicate_status(address_item
*addr
)
426 for (address_item
* addr2
= addr
->next
; addr2
; addr2
= addr2
->next
)
428 addr2
->transport
= addr
->transport
;
429 addr2
->transport_return
= addr
->transport_return
;
430 addr2
->basic_errno
= addr
->basic_errno
;
431 addr2
->more_errno
= addr
->more_errno
;
432 addr2
->delivery_usec
= addr
->delivery_usec
;
433 addr2
->special_action
= addr
->special_action
;
434 addr2
->message
= addr
->message
;
435 addr2
->user_message
= addr
->user_message
;
441 /*************************************************
442 * Compare lists of hosts *
443 *************************************************/
445 /* This function is given two pointers to chains of host items, and it yields
446 TRUE if the lists refer to the same hosts in the same order, except that
448 (1) Multiple hosts with the same non-negative MX values are permitted to appear
449 in different orders. Round-robinning nameservers can cause this to happen.
451 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
452 permitted to appear in different orders. This is caused by randomizing
455 This enables Exim to use a single SMTP transaction for sending to two entirely
456 different domains that happen to end up pointing at the same hosts.
459 one points to the first host list
460 two points to the second host list
462 Returns: TRUE if the lists refer to the same host set
466 same_hosts(host_item
*one
, host_item
*two
)
470 if (Ustrcmp(one
->name
, two
->name
) != 0)
473 host_item
*end_one
= one
;
474 host_item
*end_two
= two
;
476 /* Batch up only if there was no MX and the list was not randomized */
478 if (mx
== MX_NONE
) return FALSE
;
480 /* Find the ends of the shortest sequence of identical MX values */
482 while ( end_one
->next
&& end_one
->next
->mx
== mx
483 && end_two
->next
&& end_two
->next
->mx
== mx
)
485 end_one
= end_one
->next
;
486 end_two
= end_two
->next
;
489 /* If there aren't any duplicates, there's no match. */
491 if (end_one
== one
) return FALSE
;
493 /* For each host in the 'one' sequence, check that it appears in the 'two'
494 sequence, returning FALSE if not. */
499 for (hi
= two
; hi
!= end_two
->next
; hi
= hi
->next
)
500 if (Ustrcmp(one
->name
, hi
->name
) == 0) break;
501 if (hi
== end_two
->next
) return FALSE
;
502 if (one
== end_one
) break;
506 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
507 Ensure both are pointing at the last host, and carry on as for equality. */
512 /* if the names matched but ports do not, mismatch */
513 else if (one
->port
!= two
->port
)
522 /* True if both are NULL */
529 /*************************************************
530 * Compare header lines *
531 *************************************************/
533 /* This function is given two pointers to chains of header items, and it yields
534 TRUE if they are the same header texts in the same order.
537 one points to the first header list
538 two points to the second header list
540 Returns: TRUE if the lists refer to the same header set
544 same_headers(header_line
*one
, header_line
*two
)
546 for (;; one
= one
->next
, two
= two
->next
)
548 if (one
== two
) return TRUE
; /* Includes the case where both NULL */
549 if (!one
|| !two
) return FALSE
;
550 if (Ustrcmp(one
->text
, two
->text
) != 0) return FALSE
;
556 /*************************************************
557 * Compare string settings *
558 *************************************************/
560 /* This function is given two pointers to strings, and it returns
561 TRUE if they are the same pointer, or if the two strings are the same.
564 one points to the first string
565 two points to the second string
567 Returns: TRUE or FALSE
571 same_strings(uschar
*one
, uschar
*two
)
573 if (one
== two
) return TRUE
; /* Includes the case where both NULL */
574 if (!one
|| !two
) return FALSE
;
575 return (Ustrcmp(one
, two
) == 0);
580 /*************************************************
581 * Compare uid/gid for addresses *
582 *************************************************/
584 /* This function is given a transport and two addresses. It yields TRUE if the
585 uid/gid/initgroups settings for the two addresses are going to be the same when
590 addr1 the first address
591 addr2 the second address
593 Returns: TRUE or FALSE
597 same_ugid(transport_instance
*tp
, address_item
*addr1
, address_item
*addr2
)
599 if ( !tp
->uid_set
&& !tp
->expand_uid
600 && !tp
->deliver_as_creator
601 && ( testflag(addr1
, af_uid_set
) != testflag(addr2
, af_gid_set
)
602 || ( testflag(addr1
, af_uid_set
)
603 && ( addr1
->uid
!= addr2
->uid
604 || testflag(addr1
, af_initgroups
) != testflag(addr2
, af_initgroups
)
608 if ( !tp
->gid_set
&& !tp
->expand_gid
609 && ( testflag(addr1
, af_gid_set
) != testflag(addr2
, af_gid_set
)
610 || ( testflag(addr1
, af_gid_set
)
611 && addr1
->gid
!= addr2
->gid
621 /*************************************************
622 * Record that an address is complete *
623 *************************************************/
625 /* This function records that an address is complete. This is straightforward
626 for most addresses, where the unique address is just the full address with the
627 domain lower cased. For homonyms (addresses that are the same as one of their
628 ancestors) their are complications. Their unique addresses have \x\ prepended
629 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
632 Exim used to record the unique addresses of homonyms as "complete". This,
633 however, fails when the pattern of redirection varies over time (e.g. if taking
634 unseen copies at only some times of day) because the prepended numbers may vary
635 from one delivery run to the next. This problem is solved by never recording
636 prepended unique addresses as complete. Instead, when a homonymic address has
637 actually been delivered via a transport, we record its basic unique address
638 followed by the name of the transport. This is checked in subsequent delivery
639 runs whenever an address is routed to a transport.
641 If the completed address is a top-level one (has no parent, which means it
642 cannot be homonymic) we also add the original address to the non-recipients
643 tree, so that it gets recorded in the spool file and therefore appears as
644 "done" in any spool listings. The original address may differ from the unique
645 address in the case of the domain.
647 Finally, this function scans the list of duplicates, marks as done any that
648 match this address, and calls child_done() for their ancestors.
651 addr address item that has been completed
652 now current time as a string
658 address_done(address_item
*addr
, uschar
*now
)
660 update_spool
= TRUE
; /* Ensure spool gets updated */
662 /* Top-level address */
666 tree_add_nonrecipient(addr
->unique
);
667 tree_add_nonrecipient(addr
->address
);
670 /* Homonymous child address */
672 else if (testflag(addr
, af_homonym
))
675 tree_add_nonrecipient(
676 string_sprintf("%s/%s", addr
->unique
+ 3, addr
->transport
->name
));
679 /* Non-homonymous child address */
681 else tree_add_nonrecipient(addr
->unique
);
683 /* Check the list of duplicate addresses and ensure they are now marked
686 for (address_item
* dup
= addr_duplicate
; dup
; dup
= dup
->next
)
687 if (Ustrcmp(addr
->unique
, dup
->unique
) == 0)
689 tree_add_nonrecipient(dup
->unique
);
690 child_done(dup
, now
);
697 /*************************************************
698 * Decrease counts in parents and mark done *
699 *************************************************/
701 /* This function is called when an address is complete. If there is a parent
702 address, its count of children is decremented. If there are still other
703 children outstanding, the function exits. Otherwise, if the count has become
704 zero, address_done() is called to mark the parent and its duplicates complete.
705 Then loop for any earlier ancestors.
708 addr points to the completed address item
709 now the current time as a string, for writing to the message log
715 child_done(address_item
*addr
, uschar
*now
)
722 if (--addr
->child_count
> 0) return; /* Incomplete parent */
723 address_done(addr
, now
);
725 /* Log the completion of all descendents only when there is no ancestor with
726 the same original address. */
728 for (aa
= addr
->parent
; aa
; aa
= aa
->parent
)
729 if (Ustrcmp(aa
->address
, addr
->address
) == 0) break;
732 deliver_msglog("%s %s: children all complete\n", now
, addr
->address
);
733 DEBUG(D_deliver
) debug_printf("%s: children all complete\n", addr
->address
);
739 /*************************************************
740 * Delivery logging support functions *
741 *************************************************/
743 /* The LOGGING() checks in d_log_interface() are complicated for backwards
744 compatibility. When outgoing interface logging was originally added, it was
745 conditional on just incoming_interface (which is off by default). The
746 outgoing_interface option is on by default to preserve this behaviour, but
747 you can enable incoming_interface and disable outgoing_interface to get I=
748 fields on incoming lines only.
752 addr The address to be logged
754 Returns: New value for s
758 d_log_interface(gstring
* g
)
760 if (LOGGING(incoming_interface
) && LOGGING(outgoing_interface
)
761 && sending_ip_address
)
763 g
= string_fmt_append(g
, " I=[%s]", sending_ip_address
);
764 if (LOGGING(outgoing_port
))
765 g
= string_fmt_append(g
, ":%d", sending_port
);
773 d_hostlog(gstring
* g
, address_item
* addr
)
775 host_item
* h
= addr
->host_used
;
777 g
= string_append(g
, 2, US
" H=", h
->name
);
779 if (LOGGING(dnssec
) && h
->dnssec
== DS_YES
)
780 g
= string_catn(g
, US
" DS", 3);
782 g
= string_append(g
, 3, US
" [", h
->address
, US
"]");
784 if (LOGGING(outgoing_port
))
785 g
= string_fmt_append(g
, ":%d", h
->port
);
788 if (LOGGING(proxy
) && proxy_local_address
)
790 g
= string_append(g
, 3, US
" PRX=[", proxy_local_address
, US
"]");
791 if (LOGGING(outgoing_port
))
792 g
= string_fmt_append(g
, ":%d", proxy_local_port
);
796 g
= d_log_interface(g
);
798 if (testflag(addr
, af_tcp_fastopen
))
799 g
= string_catn(g
, US
" TFO*", testflag(addr
, af_tcp_fastopen_data
) ? 5 : 4);
810 d_tlslog(gstring
* g
, address_item
* addr
)
812 if (LOGGING(tls_cipher
) && addr
->cipher
)
814 g
= string_append(g
, 2, US
" X=", addr
->cipher
);
815 #ifdef EXPERIMENTAL_TLS_RESUME
816 if (LOGGING(tls_resumption
) && testflag(addr
, af_tls_resume
))
817 g
= string_catn(g
, US
"*", 1);
820 if (LOGGING(tls_certificate_verified
) && addr
->cipher
)
821 g
= string_append(g
, 2, US
" CV=",
822 testflag(addr
, af_cert_verified
)
825 testflag(addr
, af_dane_verified
)
831 if (LOGGING(tls_peerdn
) && addr
->peerdn
)
832 g
= string_append(g
, 3, US
" DN=\"", string_printing(addr
->peerdn
), US
"\"");
840 #ifndef DISABLE_EVENT
842 event_raise(uschar
* action
, const uschar
* event
, uschar
* ev_data
)
848 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
850 action
, deliver_host_address
);
853 event_data
= ev_data
;
855 if (!(s
= expand_string(action
)) && *expand_string_message
)
856 log_write(0, LOG_MAIN
|LOG_PANIC
,
857 "failed to expand event_action %s in %s: %s\n",
858 event
, transport_name
? transport_name
: US
"main", expand_string_message
);
860 event_name
= event_data
= NULL
;
862 /* If the expansion returns anything but an empty string, flag for
863 the caller to modify his normal processing
868 debug_printf("Event(%s): event_action returned \"%s\"\n", event
, s
);
877 msg_event_raise(const uschar
* event
, const address_item
* addr
)
879 const uschar
* save_domain
= deliver_domain
;
880 uschar
* save_local
= deliver_localpart
;
881 const uschar
* save_host
= deliver_host
;
882 const uschar
* save_address
= deliver_host_address
;
883 const int save_port
= deliver_host_port
;
885 router_name
= addr
->router
? addr
->router
->name
: NULL
;
886 deliver_domain
= addr
->domain
;
887 deliver_localpart
= addr
->local_part
;
888 deliver_host
= addr
->host_used
? addr
->host_used
->name
: NULL
;
890 if (!addr
->transport
)
892 if (Ustrcmp(event
, "msg:fail:delivery") == 0)
894 /* An address failed with no transport involved. This happens when
895 a filter was used which triggered a fail command (in such a case
896 a transport isn't needed). Convert it to an internal fail event. */
898 (void) event_raise(event_action
, US
"msg:fail:internal", addr
->message
);
903 transport_name
= addr
->transport
->name
;
905 (void) event_raise(addr
->transport
->event_action
, event
,
907 || Ustrcmp(addr
->transport
->driver_name
, "smtp") == 0
908 || Ustrcmp(addr
->transport
->driver_name
, "lmtp") == 0
909 || Ustrcmp(addr
->transport
->driver_name
, "autoreply") == 0
910 ? addr
->message
: NULL
);
913 deliver_host_port
= save_port
;
914 deliver_host_address
= save_address
;
915 deliver_host
= save_host
;
916 deliver_localpart
= save_local
;
917 deliver_domain
= save_domain
;
918 router_name
= transport_name
= NULL
;
920 #endif /*DISABLE_EVENT*/
924 /******************************************************************************/
927 /*************************************************
928 * Generate local prt for logging *
929 *************************************************/
931 /* This function is a subroutine for use in string_log_address() below.
934 addr the address being logged
935 yield the current dynamic buffer pointer
937 Returns: the new value of the buffer pointer
941 string_get_localpart(address_item
* addr
, gstring
* yield
)
946 if (testflag(addr
, af_include_affixes
) && s
)
949 if (testflag(addr
, af_utf8_downcvt
))
950 s
= string_localpart_utf8_to_alabel(s
, NULL
);
952 yield
= string_cat(yield
, s
);
955 s
= addr
->local_part
;
957 if (testflag(addr
, af_utf8_downcvt
))
958 s
= string_localpart_utf8_to_alabel(s
, NULL
);
960 yield
= string_cat(yield
, s
);
963 if (testflag(addr
, af_include_affixes
) && s
)
966 if (testflag(addr
, af_utf8_downcvt
))
967 s
= string_localpart_utf8_to_alabel(s
, NULL
);
969 yield
= string_cat(yield
, s
);
976 /*************************************************
977 * Generate log address list *
978 *************************************************/
980 /* This function generates a list consisting of an address and its parents, for
981 use in logging lines. For saved onetime aliased addresses, the onetime parent
982 field is used. If the address was delivered by a transport with rcpt_include_
983 affixes set, the af_include_affixes bit will be set in the address. In that
984 case, we include the affixes here too.
987 g points to growing-string struct
988 addr bottom (ultimate) address
989 all_parents if TRUE, include all parents
990 success TRUE for successful delivery
992 Returns: a growable string in dynamic store
996 string_log_address(gstring
* g
,
997 address_item
*addr
, BOOL all_parents
, BOOL success
)
999 BOOL add_topaddr
= TRUE
;
1000 address_item
*topaddr
;
1002 /* Find the ultimate parent */
1004 for (topaddr
= addr
; topaddr
->parent
; topaddr
= topaddr
->parent
) ;
1006 /* We start with just the local part for pipe, file, and reply deliveries, and
1007 for successful local deliveries from routers that have the log_as_local flag
1008 set. File deliveries from filters can be specified as non-absolute paths in
1009 cases where the transport is going to complete the path. If there is an error
1010 before this happens (expansion failure) the local part will not be updated, and
1011 so won't necessarily look like a path. Add extra text for this case. */
1013 if ( testflag(addr
, af_pfr
)
1015 && addr
->router
&& addr
->router
->log_as_local
1016 && addr
->transport
&& addr
->transport
->info
->local
1019 if (testflag(addr
, af_file
) && addr
->local_part
[0] != '/')
1020 g
= string_catn(g
, CUS
"save ", 5);
1021 g
= string_get_localpart(addr
, g
);
1024 /* Other deliveries start with the full address. It we have split it into local
1025 part and domain, use those fields. Some early failures can happen before the
1026 splitting is done; in those cases use the original field. */
1031 int off
= g
->ptr
; /* start of the "full address" */
1033 if (addr
->local_part
)
1036 g
= string_get_localpart(addr
, g
);
1037 g
= string_catn(g
, US
"@", 1);
1040 if (testflag(addr
, af_utf8_downcvt
))
1041 s
= string_localpart_utf8_to_alabel(s
, NULL
);
1043 g
= string_cat(g
, s
);
1046 g
= string_cat(g
, addr
->address
);
1048 /* If the address we are going to print is the same as the top address,
1049 and all parents are not being included, don't add on the top address. First
1050 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1051 on the local parts. */
1053 cmp
= g
->s
+ off
; /* only now, as rebuffer likely done */
1054 string_from_gstring(g
); /* ensure nul-terminated */
1055 if ( strcmpic(cmp
, topaddr
->address
) == 0
1056 && Ustrncmp(cmp
, topaddr
->address
, Ustrchr(cmp
, '@') - cmp
) == 0
1057 && !addr
->onetime_parent
1058 && (!all_parents
|| !addr
->parent
|| addr
->parent
== topaddr
)
1060 add_topaddr
= FALSE
;
1063 /* If all parents are requested, or this is a local pipe/file/reply, and
1064 there is at least one intermediate parent, show it in brackets, and continue
1065 with all of them if all are wanted. */
1067 if ( (all_parents
|| testflag(addr
, af_pfr
))
1069 && addr
->parent
!= topaddr
)
1072 for (address_item
* addr2
= addr
->parent
; addr2
!= topaddr
; addr2
= addr2
->parent
)
1074 g
= string_catn(g
, s
, 2);
1075 g
= string_cat (g
, addr2
->address
);
1076 if (!all_parents
) break;
1079 g
= string_catn(g
, US
")", 1);
1082 /* Add the top address if it is required */
1085 g
= string_append(g
, 3,
1087 addr
->onetime_parent
? addr
->onetime_parent
: topaddr
->address
,
1095 /******************************************************************************/
1099 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1100 this is a nonstandard call; no two-character delivery flag is written
1101 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1104 flags passed to log_write()
1107 delivery_log(int flags
, address_item
* addr
, int logchar
, uschar
* msg
)
1109 gstring
* g
; /* Used for a temporary, expanding buffer, for building log lines */
1112 /* Log the delivery on the main log. We use an extensible string to build up
1113 the log line, and reset the store afterwards. Remote deliveries should always
1114 have a pointer to the host item that succeeded; local deliveries can have a
1115 pointer to a single host item in their host list, for use by the transport. */
1117 #ifndef DISABLE_EVENT
1118 /* presume no successful remote delivery */
1119 lookup_dnssec_authenticated
= NULL
;
1122 reset_point
= store_mark();
1123 g
= string_get_tainted(256, TRUE
); /* addrs will be tainted, so avoid copy */
1126 g
= string_append(g
, 2, host_and_ident(TRUE
), US
" ");
1129 g
->s
[0] = logchar
; g
->ptr
= 1;
1130 g
= string_catn(g
, US
"> ", 2);
1132 g
= string_log_address(g
, addr
, LOGGING(all_parents
), TRUE
);
1134 if (LOGGING(sender_on_delivery
) || msg
)
1135 g
= string_append(g
, 3, US
" F=<",
1137 testflag(addr
, af_utf8_downcvt
)
1138 ? string_address_utf8_to_alabel(sender_address
, NULL
)
1145 g
= string_append(g
, 2, US
" Q=", queue_name
);
1147 #ifdef EXPERIMENTAL_SRS
1148 if(addr
->prop
.srs_sender
)
1149 g
= string_append(g
, 3, US
" SRS=<", addr
->prop
.srs_sender
, US
">");
1152 /* You might think that the return path must always be set for a successful
1153 delivery; indeed, I did for some time, until this statement crashed. The case
1154 when it is not set is for a delivery to /dev/null which is optimised by not
1155 being run at all. */
1157 if (used_return_path
&& LOGGING(return_path_on_delivery
))
1158 g
= string_append(g
, 3, US
" P=<", used_return_path
, US
">");
1161 g
= string_append(g
, 2, US
" ", msg
);
1163 /* For a delivery from a system filter, there may not be a router */
1165 g
= string_append(g
, 2, US
" R=", addr
->router
->name
);
1167 g
= string_append(g
, 2, US
" T=", addr
->transport
->name
);
1169 if (LOGGING(delivery_size
))
1170 g
= string_fmt_append(g
, " S=%d", transport_count
);
1172 /* Local delivery */
1174 if (addr
->transport
->info
->local
)
1176 if (addr
->host_list
)
1177 g
= string_append(g
, 2, US
" H=", addr
->host_list
->name
);
1178 g
= d_log_interface(g
);
1179 if (addr
->shadow_message
)
1180 g
= string_cat(g
, addr
->shadow_message
);
1183 /* Remote delivery */
1187 if (addr
->host_used
)
1189 g
= d_hostlog(g
, addr
);
1190 if (continue_sequence
> 1)
1191 g
= string_catn(g
, US
"*", 1);
1193 #ifndef DISABLE_EVENT
1194 deliver_host_address
= addr
->host_used
->address
;
1195 deliver_host_port
= addr
->host_used
->port
;
1196 deliver_host
= addr
->host_used
->name
;
1198 /* DNS lookup status */
1199 lookup_dnssec_authenticated
= addr
->host_used
->dnssec
==DS_YES
? US
"yes"
1200 : addr
->host_used
->dnssec
==DS_NO
? US
"no"
1206 g
= d_tlslog(g
, addr
);
1209 if (addr
->authenticator
)
1211 g
= string_append(g
, 2, US
" A=", addr
->authenticator
);
1214 g
= string_append(g
, 2, US
":", addr
->auth_id
);
1215 if (LOGGING(smtp_mailauth
) && addr
->auth_sndr
)
1216 g
= string_append(g
, 2, US
":", addr
->auth_sndr
);
1220 if (LOGGING(pipelining
))
1222 if (testflag(addr
, af_pipelining
))
1223 g
= string_catn(g
, US
" L", 2);
1224 #ifndef DISABLE_PIPE_CONNECT
1225 if (testflag(addr
, af_early_pipe
))
1226 g
= string_catn(g
, US
"*", 1);
1230 #ifndef DISABLE_PRDR
1231 if (testflag(addr
, af_prdr_used
))
1232 g
= string_catn(g
, US
" PRDR", 5);
1235 if (testflag(addr
, af_chunking_used
))
1236 g
= string_catn(g
, US
" K", 2);
1239 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1241 if ( LOGGING(smtp_confirmation
)
1243 && (addr
->host_used
|| Ustrcmp(addr
->transport
->driver_name
, "lmtp") == 0)
1246 unsigned lim
= big_buffer_size
< 1024 ? big_buffer_size
: 1024;
1247 uschar
*p
= big_buffer
;
1248 uschar
*ss
= addr
->message
;
1250 for (int i
= 0; i
< lim
&& ss
[i
] != 0; i
++) /* limit logged amount */
1252 if (ss
[i
] == '\"' || ss
[i
] == '\\') *p
++ = '\\'; /* quote \ and " */
1257 g
= string_append(g
, 2, US
" C=", big_buffer
);
1260 /* Time on queue and actual time taken to deliver */
1262 if (LOGGING(queue_time
))
1263 g
= string_append(g
, 2, US
" QT=",
1264 string_timesince(&received_time
));
1266 if (LOGGING(deliver_time
))
1268 struct timeval diff
= {.tv_sec
= addr
->more_errno
, .tv_usec
= addr
->delivery_usec
};
1269 g
= string_append(g
, 2, US
" DT=", string_timediff(&diff
));
1272 /* string_cat() always leaves room for the terminator. Release the
1273 store we used to build the line after writing it. */
1275 log_write(0, flags
, "%s", string_from_gstring(g
));
1277 #ifndef DISABLE_EVENT
1278 if (!msg
) msg_event_raise(US
"msg:delivery", addr
);
1281 store_reset(reset_point
);
1288 deferral_log(address_item
* addr
, uschar
* now
,
1289 int logflags
, uschar
* driver_name
, uschar
* driver_kind
)
1291 rmark reset_point
= store_mark();
1292 gstring
* g
= string_get(256);
1294 /* Build up the line that is used for both the message log and the main
1297 /* Create the address string for logging. Must not do this earlier, because
1298 an OK result may be changed to FAIL when a pipe returns text. */
1300 g
= string_log_address(g
, addr
, LOGGING(all_parents
), FALSE
);
1303 g
= string_append(g
, 2, US
" Q=", queue_name
);
1305 /* Either driver_name contains something and driver_kind contains
1306 " router" or " transport" (note the leading space), or driver_name is
1307 a null string and driver_kind contains "routing" without the leading
1308 space, if all routing has been deferred. When a domain has been held,
1309 so nothing has been done at all, both variables contain null strings. */
1313 if (driver_kind
[1] == 't' && addr
->router
)
1314 g
= string_append(g
, 2, US
" R=", addr
->router
->name
);
1315 g
= string_fmt_append(g
, " %c=%s", toupper(driver_kind
[1]), driver_name
);
1317 else if (driver_kind
)
1318 g
= string_append(g
, 2, US
" ", driver_kind
);
1320 g
= string_fmt_append(g
, " defer (%d)", addr
->basic_errno
);
1322 if (addr
->basic_errno
> 0)
1323 g
= string_append(g
, 2, US
": ",
1324 US
strerror(addr
->basic_errno
));
1326 if (addr
->host_used
)
1328 g
= string_append(g
, 5,
1329 US
" H=", addr
->host_used
->name
,
1330 US
" [", addr
->host_used
->address
, US
"]");
1331 if (LOGGING(outgoing_port
))
1333 int port
= addr
->host_used
->port
;
1334 g
= string_fmt_append(g
, ":%d", port
== PORT_NONE
? 25 : port
);
1339 g
= string_append(g
, 2, US
": ", addr
->message
);
1341 (void) string_from_gstring(g
);
1343 /* Log the deferment in the message log, but don't clutter it
1344 up with retry-time defers after the first delivery attempt. */
1346 if (f
.deliver_firsttime
|| addr
->basic_errno
> ERRNO_RETRY_BASE
)
1347 deliver_msglog("%s %s\n", now
, g
->s
);
1349 /* Write the main log and reset the store.
1350 For errors of the type "retry time not reached" (also remotes skipped
1351 on queue run), logging is controlled by L_retry_defer. Note that this kind
1352 of error number is negative, and all the retry ones are less than any
1356 log_write(addr
->basic_errno
<= ERRNO_RETRY_BASE
? L_retry_defer
: 0, logflags
,
1359 store_reset(reset_point
);
1366 failure_log(address_item
* addr
, uschar
* driver_kind
, uschar
* now
)
1368 rmark reset_point
= store_mark();
1369 gstring
* g
= string_get(256);
1371 #ifndef DISABLE_EVENT
1372 /* Message failures for which we will send a DSN get their event raised
1373 later so avoid doing it here. */
1375 if ( !addr
->prop
.ignore_error
1376 && !(addr
->dsn_flags
& (rf_dsnflags
& ~rf_notify_failure
))
1378 msg_event_raise(US
"msg:fail:delivery", addr
);
1381 /* Build up the log line for the message and main logs */
1383 /* Create the address string for logging. Must not do this earlier, because
1384 an OK result may be changed to FAIL when a pipe returns text. */
1386 g
= string_log_address(g
, addr
, LOGGING(all_parents
), FALSE
);
1388 if (LOGGING(sender_on_delivery
))
1389 g
= string_append(g
, 3, US
" F=<", sender_address
, US
">");
1392 g
= string_append(g
, 2, US
" Q=", queue_name
);
1394 /* Return path may not be set if no delivery actually happened */
1396 if (used_return_path
&& LOGGING(return_path_on_delivery
))
1397 g
= string_append(g
, 3, US
" P=<", used_return_path
, US
">");
1400 g
= string_append(g
, 2, US
" R=", addr
->router
->name
);
1401 if (addr
->transport
)
1402 g
= string_append(g
, 2, US
" T=", addr
->transport
->name
);
1404 if (addr
->host_used
)
1405 g
= d_hostlog(g
, addr
);
1408 g
= d_tlslog(g
, addr
);
1411 if (addr
->basic_errno
> 0)
1412 g
= string_append(g
, 2, US
": ", US
strerror(addr
->basic_errno
));
1415 g
= string_append(g
, 2, US
": ", addr
->message
);
1417 (void) string_from_gstring(g
);
1419 /* Do the logging. For the message log, "routing failed" for those cases,
1420 just to make it clearer. */
1423 deliver_msglog("%s %s failed for %s\n", now
, driver_kind
, g
->s
);
1425 deliver_msglog("%s %s\n", now
, g
->s
);
1427 log_write(0, LOG_MAIN
, "** %s", g
->s
);
1429 store_reset(reset_point
);
1435 /*************************************************
1436 * Actions at the end of handling an address *
1437 *************************************************/
1439 /* This is a function for processing a single address when all that can be done
1440 with it has been done.
1443 addr points to the address block
1444 result the result of the delivery attempt
1445 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1446 driver_type indicates which type of driver (transport, or router) was last
1447 to process the address
1448 logchar '=' or '-' for use when logging deliveries with => or ->
1454 post_process_one(address_item
*addr
, int result
, int logflags
, int driver_type
,
1457 uschar
*now
= tod_stamp(tod_log
);
1458 uschar
*driver_kind
= NULL
;
1459 uschar
*driver_name
= NULL
;
1461 DEBUG(D_deliver
) debug_printf("post-process %s (%d)\n", addr
->address
, result
);
1463 /* Set up driver kind and name for logging. Disable logging if the router or
1464 transport has disabled it. */
1466 if (driver_type
== EXIM_DTYPE_TRANSPORT
)
1468 if (addr
->transport
)
1470 driver_name
= addr
->transport
->name
;
1471 driver_kind
= US
" transport";
1472 f
.disable_logging
= addr
->transport
->disable_logging
;
1474 else driver_kind
= US
"transporting";
1476 else if (driver_type
== EXIM_DTYPE_ROUTER
)
1480 driver_name
= addr
->router
->name
;
1481 driver_kind
= US
" router";
1482 f
.disable_logging
= addr
->router
->disable_logging
;
1484 else driver_kind
= US
"routing";
1487 /* If there's an error message set, ensure that it contains only printing
1488 characters - it should, but occasionally things slip in and this at least
1489 stops the log format from getting wrecked. We also scan the message for an LDAP
1490 expansion item that has a password setting, and flatten the password. This is a
1491 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1492 malformed, it won't ever have gone near LDAP.) */
1496 const uschar
* s
= string_printing(addr
->message
);
1498 /* deconst cast ok as string_printing known to have alloc'n'copied */
1499 addr
->message
= expand_hide_passwords(US s
);
1502 /* If we used a transport that has one of the "return_output" options set, and
1503 if it did in fact generate some output, then for return_output we treat the
1504 message as failed if it was not already set that way, so that the output gets
1505 returned to the sender, provided there is a sender to send it to. For
1506 return_fail_output, do this only if the delivery failed. Otherwise we just
1507 unlink the file, and remove the name so that if the delivery failed, we don't
1508 try to send back an empty or unwanted file. The log_output options operate only
1509 on a non-empty file.
1511 In any case, we close the message file, because we cannot afford to leave a
1512 file-descriptor for one address while processing (maybe very many) others. */
1514 if (addr
->return_file
>= 0 && addr
->return_filename
)
1516 BOOL return_output
= FALSE
;
1517 struct stat statbuf
;
1518 (void)EXIMfsync(addr
->return_file
);
1520 /* If there is no output, do nothing. */
1522 if (fstat(addr
->return_file
, &statbuf
) == 0 && statbuf
.st_size
> 0)
1524 transport_instance
*tb
= addr
->transport
;
1526 /* Handle logging options */
1529 || result
== FAIL
&& tb
->log_fail_output
1530 || result
== DEFER
&& tb
->log_defer_output
1534 FILE *f
= Ufopen(addr
->return_filename
, "rb");
1536 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to open %s to log output "
1537 "from %s transport: %s", addr
->return_filename
, tb
->name
,
1540 if ((s
= US
Ufgets(big_buffer
, big_buffer_size
, f
)))
1542 uschar
*p
= big_buffer
+ Ustrlen(big_buffer
);
1544 while (p
> big_buffer
&& isspace(p
[-1])) p
--;
1546 sp
= string_printing(big_buffer
);
1547 log_write(0, LOG_MAIN
, "<%s>: %s transport output: %s",
1548 addr
->address
, tb
->name
, sp
);
1553 /* Handle returning options, but only if there is an address to return
1556 if (sender_address
[0] != 0 || addr
->prop
.errors_address
)
1557 if (tb
->return_output
)
1559 addr
->transport_return
= result
= FAIL
;
1560 if (addr
->basic_errno
== 0 && !addr
->message
)
1561 addr
->message
= US
"return message generated";
1562 return_output
= TRUE
;
1565 if (tb
->return_fail_output
&& result
== FAIL
) return_output
= TRUE
;
1568 /* Get rid of the file unless it might be returned, but close it in
1573 Uunlink(addr
->return_filename
);
1574 addr
->return_filename
= NULL
;
1575 addr
->return_file
= -1;
1578 (void)close(addr
->return_file
);
1581 /* The success case happens only after delivery by a transport. */
1585 addr
->next
= addr_succeed
;
1586 addr_succeed
= addr
;
1588 /* Call address_done() to ensure that we don't deliver to this address again,
1589 and write appropriate things to the message log. If it is a child address, we
1590 call child_done() to scan the ancestors and mark them complete if this is the
1591 last child to complete. */
1593 address_done(addr
, now
);
1594 DEBUG(D_deliver
) debug_printf("%s delivered\n", addr
->address
);
1597 deliver_msglog("%s %s: %s%s succeeded\n", now
, addr
->address
,
1598 driver_name
, driver_kind
);
1601 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now
, addr
->address
,
1602 addr
->parent
->address
, driver_name
, driver_kind
);
1603 child_done(addr
, now
);
1606 /* Certificates for logging (via events) */
1608 tls_out
.ourcert
= addr
->ourcert
;
1609 addr
->ourcert
= NULL
;
1610 tls_out
.peercert
= addr
->peercert
;
1611 addr
->peercert
= NULL
;
1613 tls_out
.ver
= addr
->tlsver
;
1614 tls_out
.cipher
= addr
->cipher
;
1615 tls_out
.peerdn
= addr
->peerdn
;
1616 tls_out
.ocsp
= addr
->ocsp
;
1617 # ifdef SUPPORT_DANE
1618 tls_out
.dane_verified
= testflag(addr
, af_dane_verified
);
1622 delivery_log(LOG_MAIN
, addr
, logchar
, NULL
);
1625 tls_free_cert(&tls_out
.ourcert
);
1626 tls_free_cert(&tls_out
.peercert
);
1628 tls_out
.cipher
= NULL
;
1629 tls_out
.peerdn
= NULL
;
1630 tls_out
.ocsp
= OCSP_NOT_REQ
;
1631 # ifdef SUPPORT_DANE
1632 tls_out
.dane_verified
= FALSE
;
1638 /* Soft failure, or local delivery process failed; freezing may be
1641 else if (result
== DEFER
|| result
== PANIC
)
1643 if (result
== PANIC
) logflags
|= LOG_PANIC
;
1645 /* This puts them on the chain in reverse order. Do not change this, because
1646 the code for handling retries assumes that the one with the retry
1647 information is last. */
1649 addr
->next
= addr_defer
;
1652 /* The only currently implemented special action is to freeze the
1653 message. Logging of this is done later, just before the -H file is
1656 if (addr
->special_action
== SPECIAL_FREEZE
)
1658 f
.deliver_freeze
= TRUE
;
1659 deliver_frozen_at
= time(NULL
);
1660 update_spool
= TRUE
;
1663 /* If doing a 2-stage queue run, we skip writing to either the message
1664 log or the main log for SMTP defers. */
1666 if (!f
.queue_2stage
|| addr
->basic_errno
!= 0)
1667 deferral_log(addr
, now
, logflags
, driver_name
, driver_kind
);
1671 /* Hard failure. If there is an address to which an error message can be sent,
1672 put this address on the failed list. If not, put it on the deferred list and
1673 freeze the mail message for human attention. The latter action can also be
1674 explicitly requested by a router or transport. */
1678 /* If this is a delivery error, or a message for which no replies are
1679 wanted, and the message's age is greater than ignore_bounce_errors_after,
1680 force the af_ignore_error flag. This will cause the address to be discarded
1681 later (with a log entry). */
1683 if (!*sender_address
&& message_age
>= ignore_bounce_errors_after
)
1684 addr
->prop
.ignore_error
= TRUE
;
1686 /* Freeze the message if requested, or if this is a bounce message (or other
1687 message with null sender) and this address does not have its own errors
1688 address. However, don't freeze if errors are being ignored. The actual code
1689 to ignore occurs later, instead of sending a message. Logging of freezing
1690 occurs later, just before writing the -H file. */
1692 if ( !addr
->prop
.ignore_error
1693 && ( addr
->special_action
== SPECIAL_FREEZE
1694 || (sender_address
[0] == 0 && !addr
->prop
.errors_address
)
1697 frozen_info
= addr
->special_action
== SPECIAL_FREEZE
1699 : f
.sender_local
&& !f
.local_error_message
1700 ? US
" (message created with -f <>)"
1701 : US
" (delivery error message)";
1702 f
.deliver_freeze
= TRUE
;
1703 deliver_frozen_at
= time(NULL
);
1704 update_spool
= TRUE
;
1706 /* The address is put on the defer rather than the failed queue, because
1707 the message is being retained. */
1709 addr
->next
= addr_defer
;
1713 /* Don't put the address on the nonrecipients tree yet; wait until an
1714 error message has been successfully sent. */
1718 addr
->next
= addr_failed
;
1722 failure_log(addr
, driver_name
? NULL
: driver_kind
, now
);
1725 /* Ensure logging is turned on again in all cases */
1727 f
.disable_logging
= FALSE
;
1733 /*************************************************
1734 * Address-independent error *
1735 *************************************************/
1737 /* This function is called when there's an error that is not dependent on a
1738 particular address, such as an expansion string failure. It puts the error into
1739 all the addresses in a batch, logs the incident on the main and panic logs, and
1740 clears the expansions. It is mostly called from local_deliver(), but can be
1741 called for a remote delivery via findugid().
1744 logit TRUE if (MAIN+PANIC) logging required
1745 addr the first of the chain of addresses
1747 format format string for error message, or NULL if already set in addr
1748 ... arguments for the format
1754 common_error(BOOL logit
, address_item
*addr
, int code
, uschar
*format
, ...)
1756 addr
->basic_errno
= code
;
1763 va_start(ap
, format
);
1764 g
= string_vformat(NULL
, SVFMT_EXTEND
|SVFMT_REBUFFER
, CS format
, ap
);
1766 addr
->message
= string_from_gstring(g
);
1769 for (address_item
* addr2
= addr
->next
; addr2
; addr2
= addr2
->next
)
1771 addr2
->basic_errno
= code
;
1772 addr2
->message
= addr
->message
;
1775 if (logit
) log_write(0, LOG_MAIN
|LOG_PANIC
, "%s", addr
->message
);
1776 deliver_set_expansions(NULL
);
1782 /*************************************************
1783 * Check a "never users" list *
1784 *************************************************/
1786 /* This function is called to check whether a uid is on one of the two "never
1790 uid the uid to be checked
1791 nusers the list to be scanned; the first item in the list is the count
1793 Returns: TRUE if the uid is on the list
1797 check_never_users(uid_t uid
, uid_t
*nusers
)
1799 if (!nusers
) return FALSE
;
1800 for (int i
= 1; i
<= (int)(nusers
[0]); i
++) if (nusers
[i
] == uid
) return TRUE
;
1806 /*************************************************
1807 * Find uid and gid for a transport *
1808 *************************************************/
1810 /* This function is called for both local and remote deliveries, to find the
1811 uid/gid under which to run the delivery. The values are taken preferentially
1812 from the transport (either explicit or deliver_as_creator), then from the
1813 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1814 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1815 panic error is logged, and the function fails (which normally leads to delivery
1819 addr the address (possibly a chain)
1821 uidp pointer to uid field
1822 gidp pointer to gid field
1823 igfp pointer to the use_initgroups field
1825 Returns: FALSE if failed - error has been set in address(es)
1829 findugid(address_item
*addr
, transport_instance
*tp
, uid_t
*uidp
, gid_t
*gidp
,
1833 BOOL gid_set
= FALSE
;
1835 /* Default initgroups flag comes from the transport */
1837 *igfp
= tp
->initgroups
;
1839 /* First see if there's a gid on the transport, either fixed or expandable.
1840 The expanding function always logs failure itself. */
1847 else if (tp
->expand_gid
)
1849 if (!route_find_expanded_group(tp
->expand_gid
, tp
->name
, US
"transport", gidp
,
1852 common_error(FALSE
, addr
, ERRNO_GIDFAIL
, NULL
);
1858 /* If the transport did not set a group, see if the router did. */
1860 if (!gid_set
&& testflag(addr
, af_gid_set
))
1866 /* Pick up a uid from the transport if one is set. */
1868 if (tp
->uid_set
) *uidp
= tp
->uid
;
1870 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1871 it does not provide a passwd value from which a gid can be taken. */
1873 else if (tp
->expand_uid
)
1876 if (!route_find_expanded_user(tp
->expand_uid
, tp
->name
, US
"transport", &pw
,
1877 uidp
, &(addr
->message
)))
1879 common_error(FALSE
, addr
, ERRNO_UIDFAIL
, NULL
);
1889 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1891 else if (tp
->deliver_as_creator
)
1893 *uidp
= originator_uid
;
1896 *gidp
= originator_gid
;
1901 /* Otherwise see if the address specifies the uid and if so, take it and its
1904 else if (testflag(addr
, af_uid_set
))
1907 *igfp
= testflag(addr
, af_initgroups
);
1910 /* Nothing has specified the uid - default to the Exim user, and group if the
1923 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1924 defaulting to the Exim uid. In other words, if the configuration has specified
1925 a uid, it must also provide a gid. */
1929 common_error(TRUE
, addr
, ERRNO_GIDFAIL
, US
"User set without group for "
1930 "%s transport", tp
->name
);
1934 /* Check that the uid is not on the lists of banned uids that may not be used
1935 for delivery processes. */
1937 nuname
= check_never_users(*uidp
, never_users
)
1939 : check_never_users(*uidp
, fixed_never_users
)
1940 ? US
"fixed_never_users"
1944 common_error(TRUE
, addr
, ERRNO_UIDFAIL
, US
"User %ld set for %s transport "
1945 "is on the %s list", (long int)(*uidp
), tp
->name
, nuname
);
1957 /*************************************************
1958 * Check the size of a message for a transport *
1959 *************************************************/
1961 /* Checks that the message isn't too big for the selected transport.
1962 This is called only when it is known that the limit is set.
1966 addr the (first) address being delivered
1969 DEFER expansion failed or did not yield an integer
1970 FAIL message too big
1974 check_message_size(transport_instance
*tp
, address_item
*addr
)
1979 deliver_set_expansions(addr
);
1980 size_limit
= expand_string_integer(tp
->message_size_limit
, TRUE
);
1981 deliver_set_expansions(NULL
);
1983 if (expand_string_message
)
1986 addr
->message
= size_limit
== -1
1987 ? string_sprintf("failed to expand message_size_limit "
1988 "in %s transport: %s", tp
->name
, expand_string_message
)
1989 : string_sprintf("invalid message_size_limit "
1990 "in %s transport: %s", tp
->name
, expand_string_message
);
1992 else if (size_limit
> 0 && message_size
> size_limit
)
1996 string_sprintf("message is too big (transport limit = %d)",
2005 /*************************************************
2006 * Transport-time check for a previous delivery *
2007 *************************************************/
2009 /* Check that this base address hasn't previously been delivered to its routed
2010 transport. If it has been delivered, mark it done. The check is necessary at
2011 delivery time in order to handle homonymic addresses correctly in cases where
2012 the pattern of redirection changes between delivery attempts (so the unique
2013 fields change). Non-homonymic previous delivery is detected earlier, at routing
2014 time (which saves unnecessary routing).
2017 addr the address item
2018 testing TRUE if testing wanted only, without side effects
2020 Returns: TRUE if previously delivered by the transport
2024 previously_transported(address_item
*addr
, BOOL testing
)
2026 uschar
* s
= string_sprintf("%s/%s",
2027 addr
->unique
+ (testflag(addr
, af_homonym
)? 3:0), addr
->transport
->name
);
2029 if (tree_search(tree_nonrecipients
, s
) != 0)
2031 DEBUG(D_deliver
|D_route
|D_transport
)
2032 debug_printf("%s was previously delivered (%s transport): discarded\n",
2033 addr
->address
, addr
->transport
->name
);
2034 if (!testing
) child_done(addr
, tod_stamp(tod_log
));
2043 /******************************************************
2044 * Check for a given header in a header string *
2045 ******************************************************/
2047 /* This function is used when generating quota warnings. The configuration may
2048 specify any header lines it likes in quota_warn_message. If certain of them are
2049 missing, defaults are inserted, so we need to be able to test for the presence
2053 hdr the required header name
2054 hstring the header string
2056 Returns: TRUE the header is in the string
2057 FALSE the header is not in the string
2061 contains_header(uschar
*hdr
, uschar
*hstring
)
2063 int len
= Ustrlen(hdr
);
2064 uschar
*p
= hstring
;
2067 if (strncmpic(p
, hdr
, len
) == 0)
2070 while (*p
== ' ' || *p
== '\t') p
++;
2071 if (*p
== ':') return TRUE
;
2073 while (*p
!= 0 && *p
!= '\n') p
++;
2074 if (*p
== '\n') p
++;
2082 /*************************************************
2083 * Perform a local delivery *
2084 *************************************************/
2086 /* Each local delivery is performed in a separate process which sets its
2087 uid and gid as specified. This is a safer way than simply changing and
2088 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2089 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2090 all systems have seteuid().
2092 If the uid/gid are specified in the transport_instance, they are used; the
2093 transport initialization must ensure that either both or neither are set.
2094 Otherwise, the values associated with the address are used. If neither are set,
2095 it is a configuration error.
2097 The transport or the address may specify a home directory (transport over-
2098 rides), and if they do, this is set as $home. If neither have set a working
2099 directory, this value is used for that as well. Otherwise $home is left unset
2100 and the cwd is set to "/" - a directory that should be accessible to all users.
2102 Using a separate process makes it more complicated to get error information
2103 back. We use a pipe to pass the return code and also an error code and error
2104 text string back to the parent process.
2107 addr points to an address block for this delivery; for "normal" local
2108 deliveries this is the only address to be delivered, but for
2109 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2110 a number of addresses can be handled simultaneously, and in this
2111 case addr will point to a chain of addresses with the same
2114 shadowing TRUE if running a shadow transport; this causes output from pipes
2121 deliver_local(address_item
*addr
, BOOL shadowing
)
2123 BOOL use_initgroups
;
2126 int status
, len
, rc
;
2129 uschar
*working_directory
;
2130 address_item
*addr2
;
2131 transport_instance
*tp
= addr
->transport
;
2133 /* Set up the return path from the errors or sender address. If the transport
2134 has its own return path setting, expand it and replace the existing value. */
2136 if(addr
->prop
.errors_address
)
2137 return_path
= addr
->prop
.errors_address
;
2138 #ifdef EXPERIMENTAL_SRS
2139 else if (addr
->prop
.srs_sender
)
2140 return_path
= addr
->prop
.srs_sender
;
2143 return_path
= sender_address
;
2145 if (tp
->return_path
)
2147 uschar
*new_return_path
= expand_string(tp
->return_path
);
2148 if (!new_return_path
)
2150 if (!f
.expand_string_forcedfail
)
2152 common_error(TRUE
, addr
, ERRNO_EXPANDFAIL
,
2153 US
"Failed to expand return path \"%s\" in %s transport: %s",
2154 tp
->return_path
, tp
->name
, expand_string_message
);
2158 else return_path
= new_return_path
;
2161 /* For local deliveries, one at a time, the value used for logging can just be
2162 set directly, once and for all. */
2164 used_return_path
= return_path
;
2166 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2167 gets put into the address(es), and the expansions are unset, so we can just
2170 if (!findugid(addr
, tp
, &uid
, &gid
, &use_initgroups
)) return;
2172 /* See if either the transport or the address specifies a home directory. A
2173 home directory set in the address may already be expanded; a flag is set to
2174 indicate that. In other cases we must expand it. */
2176 if ( (deliver_home
= tp
->home_dir
) /* Set in transport, or */
2177 || ( (deliver_home
= addr
->home_dir
) /* Set in address and */
2178 && !testflag(addr
, af_home_expanded
) /* not expanded */
2181 uschar
*rawhome
= deliver_home
;
2182 deliver_home
= NULL
; /* in case it contains $home */
2183 if (!(deliver_home
= expand_string(rawhome
)))
2185 common_error(TRUE
, addr
, ERRNO_EXPANDFAIL
, US
"home directory \"%s\" failed "
2186 "to expand for %s transport: %s", rawhome
, tp
->name
,
2187 expand_string_message
);
2190 if (*deliver_home
!= '/')
2192 common_error(TRUE
, addr
, ERRNO_NOTABSOLUTE
, US
"home directory path \"%s\" "
2193 "is not absolute for %s transport", deliver_home
, tp
->name
);
2198 /* See if either the transport or the address specifies a current directory,
2199 and if so, expand it. If nothing is set, use the home directory, unless it is
2200 also unset in which case use "/", which is assumed to be a directory to which
2201 all users have access. It is necessary to be in a visible directory for some
2202 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2203 2.5) require this. */
2205 working_directory
= tp
->current_dir
? tp
->current_dir
: addr
->current_dir
;
2206 if (working_directory
)
2208 uschar
*raw
= working_directory
;
2209 if (!(working_directory
= expand_string(raw
)))
2211 common_error(TRUE
, addr
, ERRNO_EXPANDFAIL
, US
"current directory \"%s\" "
2212 "failed to expand for %s transport: %s", raw
, tp
->name
,
2213 expand_string_message
);
2216 if (*working_directory
!= '/')
2218 common_error(TRUE
, addr
, ERRNO_NOTABSOLUTE
, US
"current directory path "
2219 "\"%s\" is not absolute for %s transport", working_directory
, tp
->name
);
2223 else working_directory
= deliver_home
? deliver_home
: US
"/";
2225 /* If one of the return_output flags is set on the transport, create and open a
2226 file in the message log directory for the transport to write its output onto.
2227 This is mainly used by pipe transports. The file needs to be unique to the
2228 address. This feature is not available for shadow transports. */
2231 && ( tp
->return_output
|| tp
->return_fail_output
2232 || tp
->log_output
|| tp
->log_fail_output
|| tp
->log_defer_output
2237 addr
->return_filename
=
2238 spool_fname(US
"msglog", message_subdir
, message_id
,
2239 string_sprintf("-%d-%d", getpid(), return_count
++));
2241 if ((addr
->return_file
= open_msglog_file(addr
->return_filename
, 0400, &error
)) < 0)
2243 common_error(TRUE
, addr
, errno
, US
"Unable to %s file for %s transport "
2244 "to return message: %s", error
, tp
->name
, strerror(errno
));
2249 /* Create the pipe for inter-process communication. */
2253 common_error(TRUE
, addr
, ERRNO_PIPEFAIL
, US
"Creation of pipe failed: %s",
2258 /* Now fork the process to do the real work in the subprocess, but first
2259 ensure that all cached resources are freed so that the subprocess starts with
2260 a clean slate and doesn't interfere with the parent process. */
2264 if ((pid
= fork()) == 0)
2266 BOOL replicate
= TRUE
;
2268 /* Prevent core dumps, as we don't want them in users' home directories.
2269 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2270 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2271 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2272 complain if the error is "not supported".
2274 There are two scenarios where changing the max limit has an effect. In one,
2275 the user is using a .forward and invoking a command of their choice via pipe;
2276 for these, we do need the max limit to be 0 unless the admin chooses to
2277 permit an increased limit. In the other, the command is invoked directly by
2278 the transport and is under administrator control, thus being able to raise
2279 the limit aids in debugging. So there's no general always-right answer.
2281 Thus we inhibit core-dumps completely but let individual transports, while
2282 still root, re-raise the limits back up to aid debugging. We make the
2283 default be no core-dumps -- few enough people can use core dumps in
2284 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2291 if (setrlimit(RLIMIT_CORE
, &rl
) < 0)
2293 # ifdef SETRLIMIT_NOT_SUPPORTED
2294 if (errno
!= ENOSYS
&& errno
!= ENOTSUP
)
2296 log_write(0, LOG_MAIN
|LOG_PANIC
, "setrlimit(RLIMIT_CORE) failed: %s",
2301 /* Reset the random number generator, so different processes don't all
2302 have the same sequence. */
2306 /* If the transport has a setup entry, call this first, while still
2307 privileged. (Appendfile uses this to expand quota, for example, while
2308 able to read private files.) */
2310 if (addr
->transport
->setup
)
2311 switch((addr
->transport
->setup
)(addr
->transport
, addr
, NULL
, uid
, gid
,
2315 addr
->transport_return
= DEFER
;
2319 addr
->transport_return
= PANIC
;
2323 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2324 when the process becomes unprivileged, it won't be able to write to the
2325 process log. SIGHUP is ignored throughout exim, except when it is being
2328 signal(SIGINT
, SIG_IGN
);
2329 signal(SIGTERM
, SIG_IGN
);
2330 signal(SIGUSR1
, SIG_IGN
);
2332 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2333 half - for transports that exec things (e.g. pipe). Then set the required
2336 (void)close(pfd
[pipe_read
]);
2337 (void)fcntl(pfd
[pipe_write
], F_SETFD
, fcntl(pfd
[pipe_write
], F_GETFD
) |
2339 exim_setugid(uid
, gid
, use_initgroups
,
2340 string_sprintf("local delivery to %s <%s> transport=%s", addr
->local_part
,
2341 addr
->address
, addr
->transport
->name
));
2345 debug_printf(" home=%s current=%s\n", deliver_home
, working_directory
);
2346 for (address_item
* batched
= addr
->next
; batched
; batched
= batched
->next
)
2347 debug_printf("additional batched address: %s\n", batched
->address
);
2350 /* Set an appropriate working directory. */
2352 if (Uchdir(working_directory
) < 0)
2354 addr
->transport_return
= DEFER
;
2355 addr
->basic_errno
= errno
;
2356 addr
->message
= string_sprintf("failed to chdir to %s", working_directory
);
2359 /* If successful, call the transport */
2364 set_process_info("delivering %s to %s using %s", message_id
,
2365 addr
->local_part
, addr
->transport
->name
);
2367 /* Setting this global in the subprocess means we need never clear it */
2368 transport_name
= addr
->transport
->name
;
2370 /* If a transport filter has been specified, set up its argument list.
2371 Any errors will get put into the address, and FALSE yielded. */
2373 if (addr
->transport
->filter_command
)
2375 ok
= transport_set_up_command(&transport_filter_argv
,
2376 addr
->transport
->filter_command
,
2377 TRUE
, PANIC
, addr
, US
"transport filter", NULL
);
2378 transport_filter_timeout
= addr
->transport
->filter_timeout
;
2380 else transport_filter_argv
= NULL
;
2384 debug_print_string(addr
->transport
->debug_string
);
2385 replicate
= !(addr
->transport
->info
->code
)(addr
->transport
, addr
);
2389 /* Pass the results back down the pipe. If necessary, first replicate the
2390 status in the top address to the others in the batch. The label is the
2391 subject of a goto when a call to the transport's setup function fails. We
2392 pass the pointer to the transport back in case it got changed as a result of
2393 file_format in appendfile. */
2397 if (replicate
) replicate_status(addr
);
2398 for (addr2
= addr
; addr2
; addr2
= addr2
->next
)
2401 int local_part_length
= Ustrlen(addr2
->local_part
);
2405 if( (ret
= write(pfd
[pipe_write
], &addr2
->transport_return
, sizeof(int))) != sizeof(int)
2406 || (ret
= write(pfd
[pipe_write
], &transport_count
, sizeof(transport_count
))) != sizeof(transport_count
)
2407 || (ret
= write(pfd
[pipe_write
], &addr2
->flags
, sizeof(addr2
->flags
))) != sizeof(addr2
->flags
)
2408 || (ret
= write(pfd
[pipe_write
], &addr2
->basic_errno
, sizeof(int))) != sizeof(int)
2409 || (ret
= write(pfd
[pipe_write
], &addr2
->more_errno
, sizeof(int))) != sizeof(int)
2410 || (ret
= write(pfd
[pipe_write
], &addr2
->delivery_usec
, sizeof(int))) != sizeof(int)
2411 || (ret
= write(pfd
[pipe_write
], &addr2
->special_action
, sizeof(int))) != sizeof(int)
2412 || (ret
= write(pfd
[pipe_write
], &addr2
->transport
,
2413 sizeof(transport_instance
*))) != sizeof(transport_instance
*)
2415 /* For a file delivery, pass back the local part, in case the original
2416 was only part of the final delivery path. This gives more complete
2419 || (testflag(addr2
, af_file
)
2420 && ( (ret
= write(pfd
[pipe_write
], &local_part_length
, sizeof(int))) != sizeof(int)
2421 || (ret
= write(pfd
[pipe_write
], addr2
->local_part
, local_part_length
)) != local_part_length
2425 log_write(0, LOG_MAIN
|LOG_PANIC
, "Failed writing transport results to pipe: %s",
2426 ret
== -1 ? strerror(errno
) : "short write");
2428 /* Now any messages */
2430 for (i
= 0, s
= addr2
->message
; i
< 2; i
++, s
= addr2
->user_message
)
2432 int message_length
= s
? Ustrlen(s
) + 1 : 0;
2433 if( (ret
= write(pfd
[pipe_write
], &message_length
, sizeof(int))) != sizeof(int)
2434 || message_length
> 0 && (ret
= write(pfd
[pipe_write
], s
, message_length
)) != message_length
2436 log_write(0, LOG_MAIN
|LOG_PANIC
, "Failed writing transport results to pipe: %s",
2437 ret
== -1 ? strerror(errno
) : "short write");
2441 /* OK, this process is now done. Free any cached resources that it opened,
2442 and close the pipe we were writing down before exiting. */
2444 (void)close(pfd
[pipe_write
]);
2449 /* Back in the main process: panic if the fork did not succeed. This seems
2450 better than returning an error - if forking is failing it is probably best
2451 not to try other deliveries for this message. */
2454 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "Fork failed for local delivery to %s",
2457 /* Read the pipe to get the delivery status codes and error messages. Our copy
2458 of the writing end must be closed first, as otherwise read() won't return zero
2459 on an empty pipe. We check that a status exists for each address before
2460 overwriting the address structure. If data is missing, the default DEFER status
2461 will remain. Afterwards, close the reading end. */
2463 (void)close(pfd
[pipe_write
]);
2465 for (addr2
= addr
; addr2
; addr2
= addr2
->next
)
2467 if ((len
= read(pfd
[pipe_read
], &status
, sizeof(int))) > 0)
2472 addr2
->transport_return
= status
;
2473 len
= read(pfd
[pipe_read
], &transport_count
,
2474 sizeof(transport_count
));
2475 len
= read(pfd
[pipe_read
], &addr2
->flags
, sizeof(addr2
->flags
));
2476 len
= read(pfd
[pipe_read
], &addr2
->basic_errno
, sizeof(int));
2477 len
= read(pfd
[pipe_read
], &addr2
->more_errno
, sizeof(int));
2478 len
= read(pfd
[pipe_read
], &addr2
->delivery_usec
, sizeof(int));
2479 len
= read(pfd
[pipe_read
], &addr2
->special_action
, sizeof(int));
2480 len
= read(pfd
[pipe_read
], &addr2
->transport
,
2481 sizeof(transport_instance
*));
2483 if (testflag(addr2
, af_file
))
2486 if ( read(pfd
[pipe_read
], &llen
, sizeof(int)) != sizeof(int)
2487 || llen
> 64*4 /* limit from rfc 5821, times I18N factor */
2490 log_write(0, LOG_MAIN
|LOG_PANIC
, "bad local_part length read"
2491 " from delivery subprocess");
2494 /* sanity-checked llen so disable the Coverity error */
2495 /* coverity[tainted_data] */
2496 if (read(pfd
[pipe_read
], big_buffer
, llen
) != llen
)
2498 log_write(0, LOG_MAIN
|LOG_PANIC
, "bad local_part read"
2499 " from delivery subprocess");
2502 big_buffer
[llen
] = 0;
2503 addr2
->local_part
= string_copy(big_buffer
);
2506 for (i
= 0, sptr
= &addr2
->message
; i
< 2; i
++, sptr
= &addr2
->user_message
)
2509 len
= read(pfd
[pipe_read
], &message_length
, sizeof(int));
2510 if (message_length
> 0)
2512 len
= read(pfd
[pipe_read
], big_buffer
, message_length
);
2513 big_buffer
[big_buffer_size
-1] = '\0'; /* guard byte */
2514 if (len
> 0) *sptr
= string_copy(big_buffer
);
2521 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to read delivery status for %s "
2522 "from delivery subprocess", addr2
->unique
);
2527 (void)close(pfd
[pipe_read
]);
2529 /* Unless shadowing, write all successful addresses immediately to the journal
2530 file, to ensure they are recorded asap. For homonymic addresses, use the base
2531 address plus the transport name. Failure to write the journal is panic-worthy,
2532 but don't stop, as it may prove possible subsequently to update the spool file
2533 in order to record the delivery. */
2537 for (addr2
= addr
; addr2
; addr2
= addr2
->next
)
2538 if (addr2
->transport_return
== OK
)
2540 if (testflag(addr2
, af_homonym
))
2541 sprintf(CS big_buffer
, "%.500s/%s\n", addr2
->unique
+ 3, tp
->name
);
2543 sprintf(CS big_buffer
, "%.500s\n", addr2
->unique
);
2545 /* In the test harness, wait just a bit to let the subprocess finish off
2546 any debug output etc first. */
2548 testharness_pause_ms(300);
2550 DEBUG(D_deliver
) debug_printf("journalling %s", big_buffer
);
2551 len
= Ustrlen(big_buffer
);
2552 if (write(journal_fd
, big_buffer
, len
) != len
)
2553 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to update journal for %s: %s",
2554 big_buffer
, strerror(errno
));
2557 /* Ensure the journal file is pushed out to disk. */
2559 if (EXIMfsync(journal_fd
) < 0)
2560 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to fsync journal: %s",
2564 /* Wait for the process to finish. If it terminates with a non-zero code,
2565 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2566 status values of all the addresses as they are. Take care to handle the case
2567 when the subprocess doesn't seem to exist. This has been seen on one system
2568 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2569 happens, wait() doesn't recognize the termination of child processes. Exim now
2570 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2572 while ((rc
= wait(&status
)) != pid
)
2573 if (rc
< 0 && errno
== ECHILD
) /* Process has vanished */
2575 log_write(0, LOG_MAIN
, "%s transport process vanished unexpectedly",
2576 addr
->transport
->driver_name
);
2581 if ((status
& 0xffff) != 0)
2583 int msb
= (status
>> 8) & 255;
2584 int lsb
= status
& 255;
2585 int code
= (msb
== 0)? (lsb
& 0x7f) : msb
;
2586 if (msb
!= 0 || (code
!= SIGTERM
&& code
!= SIGKILL
&& code
!= SIGQUIT
))
2587 addr
->special_action
= SPECIAL_FREEZE
;
2588 log_write(0, LOG_MAIN
|LOG_PANIC
, "%s transport process returned non-zero "
2589 "status 0x%04x: %s %d",
2590 addr
->transport
->driver_name
,
2592 msb
== 0 ? "terminated by signal" : "exit code",
2596 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2598 if (addr
->special_action
== SPECIAL_WARN
&& addr
->transport
->warn_message
)
2601 uschar
*warn_message
;
2604 DEBUG(D_deliver
) debug_printf("Warning message requested by transport\n");
2606 if (!(warn_message
= expand_string(addr
->transport
->warn_message
)))
2607 log_write(0, LOG_MAIN
|LOG_PANIC
, "Failed to expand \"%s\" (warning "
2608 "message for %s transport): %s", addr
->transport
->warn_message
,
2609 addr
->transport
->name
, expand_string_message
);
2611 else if ((pid
= child_open_exim(&fd
)) > 0)
2613 FILE *f
= fdopen(fd
, "wb");
2614 if (errors_reply_to
&& !contains_header(US
"Reply-To", warn_message
))
2615 fprintf(f
, "Reply-To: %s\n", errors_reply_to
);
2616 fprintf(f
, "Auto-Submitted: auto-replied\n");
2617 if (!contains_header(US
"From", warn_message
))
2619 fprintf(f
, "%s", CS warn_message
);
2621 /* Close and wait for child process to complete, without a timeout. */
2624 (void)child_close(pid
, 0);
2627 addr
->special_action
= SPECIAL_NONE
;
2634 /* Check transport for the given concurrency limit. Return TRUE if over
2635 the limit (or an expansion failure), else FALSE and if there was a limit,
2636 the key for the hints database used for the concurrency count. */
2639 tpt_parallel_check(transport_instance
* tp
, address_item
* addr
, uschar
** key
)
2641 unsigned max_parallel
;
2643 if (!tp
->max_parallel
) return FALSE
;
2645 max_parallel
= (unsigned) expand_string_integer(tp
->max_parallel
, TRUE
);
2646 if (expand_string_message
)
2648 log_write(0, LOG_MAIN
|LOG_PANIC
, "Failed to expand max_parallel option "
2649 "in %s transport (%s): %s", tp
->name
, addr
->address
,
2650 expand_string_message
);
2654 if (max_parallel
> 0)
2656 uschar
* serialize_key
= string_sprintf("tpt-serialize-%s", tp
->name
);
2657 if (!enq_start(serialize_key
, max_parallel
))
2659 address_item
* next
;
2661 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2662 tp
->name
, max_parallel
);
2666 addr
->message
= US
"concurrency limit reached for transport";
2667 addr
->basic_errno
= ERRNO_TRETRY
;
2668 post_process_one(addr
, DEFER
, LOG_MAIN
, EXIM_DTYPE_TRANSPORT
, 0);
2669 } while ((addr
= next
));
2672 *key
= serialize_key
;
2679 /*************************************************
2680 * Do local deliveries *
2681 *************************************************/
2683 /* This function processes the list of addresses in addr_local. True local
2684 deliveries are always done one address at a time. However, local deliveries can
2685 be batched up in some cases. Typically this is when writing batched SMTP output
2686 files for use by some external transport mechanism, or when running local
2687 deliveries over LMTP.
2694 do_local_deliveries(void)
2697 open_db
*dbm_file
= NULL
;
2698 time_t now
= time(NULL
);
2700 /* Loop until we have exhausted the supply of local deliveries */
2704 struct timeval delivery_start
;
2705 struct timeval deliver_time
;
2706 address_item
*addr2
, *addr3
, *nextaddr
;
2707 int logflags
= LOG_MAIN
;
2708 int logchar
= f
.dont_deliver
? '*' : '=';
2709 transport_instance
*tp
;
2710 uschar
* serialize_key
= NULL
;
2712 /* Pick the first undelivered address off the chain */
2714 address_item
*addr
= addr_local
;
2715 addr_local
= addr
->next
;
2718 DEBUG(D_deliver
|D_transport
)
2719 debug_printf("--------> %s <--------\n", addr
->address
);
2721 /* An internal disaster if there is no transport. Should not occur! */
2723 if (!(tp
= addr
->transport
))
2725 logflags
|= LOG_PANIC
;
2726 f
.disable_logging
= FALSE
; /* Jic */
2727 addr
->message
= addr
->router
2728 ? string_sprintf("No transport set by %s router", addr
->router
->name
)
2729 : US
"No transport set by system filter";
2730 post_process_one(addr
, DEFER
, logflags
, EXIM_DTYPE_TRANSPORT
, 0);
2734 /* Check that this base address hasn't previously been delivered to this
2735 transport. The check is necessary at this point to handle homonymic addresses
2736 correctly in cases where the pattern of redirection changes between delivery
2737 attempts. Non-homonymic previous delivery is detected earlier, at routing
2740 if (previously_transported(addr
, FALSE
)) continue;
2742 /* There are weird cases where logging is disabled */
2744 f
.disable_logging
= tp
->disable_logging
;
2746 /* Check for batched addresses and possible amalgamation. Skip all the work
2747 if either batch_max <= 1 or there aren't any other addresses for local
2750 if (tp
->batch_max
> 1 && addr_local
)
2752 int batch_count
= 1;
2753 BOOL uses_dom
= readconf_depends((driver_instance
*)tp
, US
"domain");
2754 BOOL uses_lp
= ( testflag(addr
, af_pfr
)
2755 && (testflag(addr
, af_file
) || addr
->local_part
[0] == '|')
2757 || readconf_depends((driver_instance
*)tp
, US
"local_part");
2758 uschar
*batch_id
= NULL
;
2759 address_item
**anchor
= &addr_local
;
2760 address_item
*last
= addr
;
2763 /* Expand the batch_id string for comparison with other addresses.
2764 Expansion failure suppresses batching. */
2768 deliver_set_expansions(addr
);
2769 batch_id
= expand_string(tp
->batch_id
);
2770 deliver_set_expansions(NULL
);
2773 log_write(0, LOG_MAIN
|LOG_PANIC
, "Failed to expand batch_id option "
2774 "in %s transport (%s): %s", tp
->name
, addr
->address
,
2775 expand_string_message
);
2776 batch_count
= tp
->batch_max
;
2780 /* Until we reach the batch_max limit, pick off addresses which have the
2781 same characteristics. These are:
2784 not previously delivered (see comment about 50 lines above)
2785 same local part if the transport's configuration contains $local_part
2786 or if this is a file or pipe delivery from a redirection
2787 same domain if the transport's configuration contains $domain
2789 same additional headers
2790 same headers to be removed
2791 same uid/gid for running the transport
2792 same first host if a host list is set
2795 while ((next
= *anchor
) && batch_count
< tp
->batch_max
)
2798 tp
== next
->transport
2799 && !previously_transported(next
, TRUE
)
2800 && testflag(addr
, af_pfr
) == testflag(next
, af_pfr
)
2801 && testflag(addr
, af_file
) == testflag(next
, af_file
)
2802 && (!uses_lp
|| Ustrcmp(next
->local_part
, addr
->local_part
) == 0)
2803 && (!uses_dom
|| Ustrcmp(next
->domain
, addr
->domain
) == 0)
2804 && same_strings(next
->prop
.errors_address
, addr
->prop
.errors_address
)
2805 && same_headers(next
->prop
.extra_headers
, addr
->prop
.extra_headers
)
2806 && same_strings(next
->prop
.remove_headers
, addr
->prop
.remove_headers
)
2807 && same_ugid(tp
, addr
, next
)
2808 && ( !addr
->host_list
&& !next
->host_list
2811 && Ustrcmp(addr
->host_list
->name
, next
->host_list
->name
) == 0
2814 /* If the transport has a batch_id setting, batch_id will be non-NULL
2815 from the expansion outside the loop. Expand for this address and compare.
2816 Expansion failure makes this address ineligible for batching. */
2821 address_item
*save_nextnext
= next
->next
;
2822 next
->next
= NULL
; /* Expansion for a single address */
2823 deliver_set_expansions(next
);
2824 next
->next
= save_nextnext
;
2825 bid
= expand_string(tp
->batch_id
);
2826 deliver_set_expansions(NULL
);
2829 log_write(0, LOG_MAIN
|LOG_PANIC
, "Failed to expand batch_id option "
2830 "in %s transport (%s): %s", tp
->name
, next
->address
,
2831 expand_string_message
);
2834 else ok
= (Ustrcmp(batch_id
, bid
) == 0);
2837 /* Take address into batch if OK. */
2841 *anchor
= next
->next
; /* Include the address */
2847 else anchor
= &next
->next
; /* Skip the address */
2851 /* We now have one or more addresses that can be delivered in a batch. Check
2852 whether the transport is prepared to accept a message of this size. If not,
2853 fail them all forthwith. If the expansion fails, or does not yield an
2854 integer, defer delivery. */
2856 if (tp
->message_size_limit
)
2858 int rc
= check_message_size(tp
, addr
);
2861 replicate_status(addr
);
2865 post_process_one(addr
, rc
, logflags
, EXIM_DTYPE_TRANSPORT
, 0);
2868 continue; /* With next batch of addresses */
2872 /* If we are not running the queue, or if forcing, all deliveries will be
2873 attempted. Otherwise, we must respect the retry times for each address. Even
2874 when not doing this, we need to set up the retry key string, and determine
2875 whether a retry record exists, because after a successful delivery, a delete
2876 retry item must be set up. Keep the retry database open only for the duration
2877 of these checks, rather than for all local deliveries, because some local
2878 deliveries (e.g. to pipes) can take a substantial time. */
2880 if (!(dbm_file
= dbfn_open(US
"retry", O_RDONLY
, &dbblock
, FALSE
, TRUE
)))
2882 DEBUG(D_deliver
|D_retry
|D_hints_lookup
)
2883 debug_printf("no retry data available\n");
2890 BOOL ok
= TRUE
; /* to deliver this address */
2893 /* Set up the retry key to include the domain or not, and change its
2894 leading character from "R" to "T". Must make a copy before doing this,
2895 because the old key may be pointed to from a "delete" retry item after
2898 retry_key
= string_copy(
2899 tp
->retry_use_local_part
? addr2
->address_retry_key
:
2900 addr2
->domain_retry_key
);
2903 /* Inspect the retry data. If there is no hints file, delivery happens. */
2907 dbdata_retry
*retry_record
= dbfn_read(dbm_file
, retry_key
);
2909 /* If there is no retry record, delivery happens. If there is,
2910 remember it exists so it can be deleted after a successful delivery. */
2914 setflag(addr2
, af_lt_retry_exists
);
2916 /* A retry record exists for this address. If queue running and not
2917 forcing, inspect its contents. If the record is too old, or if its
2918 retry time has come, or if it has passed its cutoff time, delivery
2923 debug_printf("retry record exists: age=%s ",
2924 readconf_printtime(now
- retry_record
->time_stamp
));
2925 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire
));
2926 debug_printf(" time to retry = %s expired = %d\n",
2927 readconf_printtime(retry_record
->next_try
- now
),
2928 retry_record
->expired
);
2931 if (f
.queue_running
&& !f
.deliver_force
)
2933 ok
= (now
- retry_record
->time_stamp
> retry_data_expire
)
2934 || (now
>= retry_record
->next_try
)
2935 || retry_record
->expired
;
2937 /* If we haven't reached the retry time, there is one more check
2938 to do, which is for the ultimate address timeout. */
2941 ok
= retry_ultimate_address_timeout(retry_key
, addr2
->domain
,
2945 else DEBUG(D_retry
) debug_printf("no retry record exists\n");
2948 /* This address is to be delivered. Leave it on the chain. */
2953 addr2
= addr2
->next
;
2956 /* This address is to be deferred. Take it out of the chain, and
2957 post-process it as complete. Must take it out of the chain first,
2958 because post processing puts it on another chain. */
2962 address_item
*this = addr2
;
2963 this->message
= US
"Retry time not yet reached";
2964 this->basic_errno
= ERRNO_LRETRY
;
2965 addr2
= addr3
? (addr3
->next
= addr2
->next
)
2966 : (addr
= addr2
->next
);
2967 post_process_one(this, DEFER
, logflags
, EXIM_DTYPE_TRANSPORT
, 0);
2971 if (dbm_file
) dbfn_close(dbm_file
);
2973 /* If there are no addresses left on the chain, they all deferred. Loop
2974 for the next set of addresses. */
2976 if (!addr
) continue;
2978 /* If the transport is limited for parallellism, enforce that here.
2979 We use a hints DB entry, incremented here and decremented after
2980 the transport (and any shadow transport) completes. */
2982 if (tpt_parallel_check(tp
, addr
, &serialize_key
))
2984 if (expand_string_message
)
2986 logflags
|= LOG_PANIC
;
2990 post_process_one(addr
, DEFER
, logflags
, EXIM_DTYPE_TRANSPORT
, 0);
2991 } while ((addr
= addr2
));
2993 continue; /* Loop for the next set of addresses. */
2997 /* So, finally, we do have some addresses that can be passed to the
2998 transport. Before doing so, set up variables that are relevant to a
3001 deliver_set_expansions(addr
);
3003 gettimeofday(&delivery_start
, NULL
);
3004 deliver_local(addr
, FALSE
);
3005 timesince(&deliver_time
, &delivery_start
);
3007 /* If a shadow transport (which must perforce be another local transport), is
3008 defined, and its condition is met, we must pass the message to the shadow
3009 too, but only those addresses that succeeded. We do this by making a new
3010 chain of addresses - also to keep the original chain uncontaminated. We must
3011 use a chain rather than doing it one by one, because the shadow transport may
3014 NOTE: if the condition fails because of a lookup defer, there is nothing we
3018 && ( !tp
->shadow_condition
3019 || expand_check_condition(tp
->shadow_condition
, tp
->name
, US
"transport")
3022 transport_instance
*stp
;
3023 address_item
*shadow_addr
= NULL
;
3024 address_item
**last
= &shadow_addr
;
3026 for (stp
= transports
; stp
; stp
= stp
->next
)
3027 if (Ustrcmp(stp
->name
, tp
->shadow
) == 0) break;
3030 log_write(0, LOG_MAIN
|LOG_PANIC
, "shadow transport \"%s\" not found ",
3033 /* Pick off the addresses that have succeeded, and make clones. Put into
3034 the shadow_message field a pointer to the shadow_message field of the real
3037 else for (addr2
= addr
; addr2
; addr2
= addr2
->next
)
3038 if (addr2
->transport_return
== OK
)
3040 addr3
= store_get(sizeof(address_item
), FALSE
);
3043 addr3
->shadow_message
= US
&addr2
->shadow_message
;
3044 addr3
->transport
= stp
;
3045 addr3
->transport_return
= DEFER
;
3046 addr3
->return_filename
= NULL
;
3047 addr3
->return_file
= -1;
3049 last
= &addr3
->next
;
3052 /* If we found any addresses to shadow, run the delivery, and stick any
3053 message back into the shadow_message field in the original. */
3057 int save_count
= transport_count
;
3059 DEBUG(D_deliver
|D_transport
)
3060 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3061 deliver_local(shadow_addr
, TRUE
);
3063 for(; shadow_addr
; shadow_addr
= shadow_addr
->next
)
3065 int sresult
= shadow_addr
->transport_return
;
3066 *(uschar
**)shadow_addr
->shadow_message
=
3068 ? string_sprintf(" ST=%s", stp
->name
)
3069 : string_sprintf(" ST=%s (%s%s%s)", stp
->name
,
3070 shadow_addr
->basic_errno
<= 0
3072 : US
strerror(shadow_addr
->basic_errno
),
3073 shadow_addr
->basic_errno
<= 0 || !shadow_addr
->message
3076 shadow_addr
->message
3077 ? shadow_addr
->message
3078 : shadow_addr
->basic_errno
<= 0
3082 DEBUG(D_deliver
|D_transport
)
3083 debug_printf("%s shadow transport returned %s for %s\n",
3084 stp
->name
, rc_to_string(sresult
), shadow_addr
->address
);
3087 DEBUG(D_deliver
|D_transport
)
3088 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3090 transport_count
= save_count
; /* Restore original transport count */
3094 /* Cancel the expansions that were set up for the delivery. */
3096 deliver_set_expansions(NULL
);
3098 /* If the transport was parallelism-limited, decrement the hints DB record. */
3100 if (serialize_key
) enq_end(serialize_key
);
3102 /* Now we can process the results of the real transport. We must take each
3103 address off the chain first, because post_process_one() puts it on another
3106 for (addr2
= addr
; addr2
; addr2
= nextaddr
)
3108 int result
= addr2
->transport_return
;
3109 nextaddr
= addr2
->next
;
3111 DEBUG(D_deliver
|D_transport
)
3112 debug_printf("%s transport returned %s for %s\n",
3113 tp
->name
, rc_to_string(result
), addr2
->address
);
3115 /* If there is a retry_record, or if delivery is deferred, build a retry
3116 item for setting a new retry time or deleting the old retry record from
3117 the database. These items are handled all together after all addresses
3118 have been handled (so the database is open just for a short time for
3121 if (result
== DEFER
|| testflag(addr2
, af_lt_retry_exists
))
3123 int flags
= result
== DEFER
? 0 : rf_delete
;
3124 uschar
*retry_key
= string_copy(tp
->retry_use_local_part
3125 ? addr2
->address_retry_key
: addr2
->domain_retry_key
);
3127 retry_add_item(addr2
, retry_key
, flags
);
3130 /* Done with this address */
3134 addr2
->more_errno
= deliver_time
.tv_sec
;
3135 addr2
->delivery_usec
= deliver_time
.tv_usec
;
3137 post_process_one(addr2
, result
, logflags
, EXIM_DTYPE_TRANSPORT
, logchar
);
3139 /* If a pipe delivery generated text to be sent back, the result may be
3140 changed to FAIL, and we must copy this for subsequent addresses in the
3143 if (addr2
->transport_return
!= result
)
3145 for (addr3
= nextaddr
; addr3
; addr3
= addr3
->next
)
3147 addr3
->transport_return
= addr2
->transport_return
;
3148 addr3
->basic_errno
= addr2
->basic_errno
;
3149 addr3
->message
= addr2
->message
;
3151 result
= addr2
->transport_return
;
3154 /* Whether or not the result was changed to FAIL, we need to copy the
3155 return_file value from the first address into all the addresses of the
3156 batch, so they are all listed in the error message. */
3158 addr2
->return_file
= addr
->return_file
;
3160 /* Change log character for recording successful deliveries. */
3162 if (result
== OK
) logchar
= '-';
3164 } /* Loop back for next batch of addresses */
3170 /*************************************************
3171 * Sort remote deliveries *
3172 *************************************************/
3174 /* This function is called if remote_sort_domains is set. It arranges that the
3175 chain of addresses for remote deliveries is ordered according to the strings
3176 specified. Try to make this shuffling reasonably efficient by handling
3177 sequences of addresses rather than just single ones.
3184 sort_remote_deliveries(void)
3187 address_item
**aptr
= &addr_remote
;
3188 const uschar
*listptr
= remote_sort_domains
;
3193 && (pattern
= string_nextinlist(&listptr
, &sep
, patbuf
, sizeof(patbuf
)))
3196 address_item
*moved
= NULL
;
3197 address_item
**bptr
= &moved
;
3201 address_item
**next
;
3202 deliver_domain
= (*aptr
)->domain
; /* set $domain */
3203 if (match_isinlist(deliver_domain
, (const uschar
**)&pattern
, UCHAR_MAX
+1,
3204 &domainlist_anchor
, NULL
, MCL_DOMAIN
, TRUE
, NULL
) == OK
)
3206 aptr
= &(*aptr
)->next
;
3210 next
= &(*aptr
)->next
;
3212 && (deliver_domain
= (*next
)->domain
, /* Set $domain */
3213 match_isinlist(deliver_domain
, (const uschar
**)&pattern
, UCHAR_MAX
+1,
3214 &domainlist_anchor
, NULL
, MCL_DOMAIN
, TRUE
, NULL
)) != OK
3216 next
= &(*next
)->next
;
3218 /* If the batch of non-matchers is at the end, add on any that were
3219 extracted further up the chain, and end this iteration. Otherwise,
3220 extract them from the chain and hang on the moved chain. */
3232 aptr
= &(*aptr
)->next
;
3235 /* If the loop ended because the final address matched, *aptr will
3236 be NULL. Add on to the end any extracted non-matching addresses. If
3237 *aptr is not NULL, the loop ended via "break" when *next is null, that
3238 is, there was a string of non-matching addresses at the end. In this
3239 case the extracted addresses have already been added on the end. */
3241 if (!*aptr
) *aptr
= moved
;
3246 debug_printf("remote addresses after sorting:\n");
3247 for (address_item
* addr
= addr_remote
; addr
; addr
= addr
->next
)
3248 debug_printf(" %s\n", addr
->address
);
3254 /*************************************************
3255 * Read from pipe for remote delivery subprocess *
3256 *************************************************/
3258 /* This function is called when the subprocess is complete, but can also be
3259 called before it is complete, in order to empty a pipe that is full (to prevent
3260 deadlock). It must therefore keep track of its progress in the parlist data
3263 We read the pipe to get the delivery status codes and a possible error message
3264 for each address, optionally preceded by unusability data for the hosts and
3265 also by optional retry data.
3267 Read in large chunks into the big buffer and then scan through, interpreting
3268 the data therein. In most cases, only a single read will be necessary. No
3269 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3270 that we read the next chunk when there is less than 2500 bytes left in the
3271 non-final chunk, we can assume each item is complete in the buffer before
3272 handling it. Each item is written using a single write(), which is atomic for
3273 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3274 often bigger) so even if we are reading while the subprocess is still going, we
3275 should never have only a partial item in the buffer.
3277 hs12: This assumption is not true anymore, since we get quite large items (certificate
3278 information and such).
3281 poffset the offset of the parlist item
3282 eop TRUE if the process has completed
3284 Returns: TRUE if the terminating 'Z' item has been read,
3285 or there has been a disaster (i.e. no more data needed);
3290 par_read_pipe(int poffset
, BOOL eop
)
3293 pardata
*p
= parlist
+ poffset
;
3294 address_item
*addrlist
= p
->addrlist
;
3295 address_item
*addr
= p
->addr
;
3299 uschar
*msg
= p
->msg
;
3300 BOOL done
= p
->done
;
3302 /* Loop through all items, reading from the pipe when necessary. The pipe
3303 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3304 here, as the preceding select() tells us, if data is available for reading.
3306 A read() on a "selected" handle should never block, but(!) it may return
3307 less data then we expected. (The buffer size we pass to read() shouldn't be
3308 understood as a "request", but as a "limit".)
3310 Each separate item is written to the pipe in a timely manner. But, especially for
3311 larger items, the read(2) may already return partial data from the write(2).
3313 The write is atomic mostly (depending on the amount written), but atomic does
3314 not imply "all or noting", it just is "not intermixed" with other writes on the
3315 same channel (pipe).
3319 DEBUG(D_deliver
) debug_printf("reading pipe for subprocess %d (%s)\n",
3320 (int)p
->pid
, eop
? "ended" : "not ended yet");
3324 retry_item
*r
, **rp
;
3325 uschar pipeheader
[PIPE_HEADER_SIZE
+1];
3326 uschar
*id
= &pipeheader
[0];
3327 uschar
*subid
= &pipeheader
[1];
3328 uschar
*ptr
= big_buffer
;
3329 size_t required
= PIPE_HEADER_SIZE
; /* first the pipehaeder, later the data */
3332 DEBUG(D_deliver
) debug_printf(
3333 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long
)required
, pid
);
3335 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3336 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3337 If we get less, we can assume the subprocess do be done and do not expect any further
3338 information from it. */
3340 if ((got
= readn(fd
, pipeheader
, required
)) != required
)
3342 msg
= string_sprintf("got " SSIZE_T_FMT
" of %d bytes (pipeheader) "
3343 "from transport process %d for transport %s",
3344 got
, PIPE_HEADER_SIZE
, pid
, addr
->transport
->driver_name
);
3349 pipeheader
[PIPE_HEADER_SIZE
] = '\0';
3351 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3355 /* If we can't decode the pipeheader, the subprocess seems to have a
3356 problem, we do not expect any furher information from it. */
3358 required
= Ustrtol(pipeheader
+2, &endc
, 10);
3361 msg
= string_sprintf("failed to read pipe "
3362 "from transport process %d for transport %s: error decoding size from header",
3363 pid
, addr
->transport
->driver_name
);
3370 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3371 (u_long
)required
, pid
);
3373 /* Same as above, the transport process will write the bytes announced
3374 in a timely manner, so we can just wait for the bytes, getting less than expected
3375 is considered a problem of the subprocess, we do not expect anything else from it. */
3376 if ((got
= readn(fd
, big_buffer
, required
)) != required
)
3378 msg
= string_sprintf("got only " SSIZE_T_FMT
" of " SIZE_T_FMT
3379 " bytes (pipedata) from transport process %d for transport %s",
3380 got
, required
, pid
, addr
->transport
->driver_name
);
3385 /* Handle each possible type of item, assuming the complete item is
3386 available in store. */
3390 /* Host items exist only if any hosts were marked unusable. Match
3391 up by checking the IP address. */
3394 for (h
= addrlist
->host_list
; h
; h
= h
->next
)
3396 if (!h
->address
|| Ustrcmp(h
->address
, ptr
+2) != 0) continue;
3404 /* Retry items are sent in a preceding R item for each address. This is
3405 kept separate to keep each message short enough to guarantee it won't
3406 be split in the pipe. Hopefully, in the majority of cases, there won't in
3407 fact be any retry items at all.
3409 The complete set of retry items might include an item to delete a
3410 routing retry if there was a previous routing delay. However, routing
3411 retries are also used when a remote transport identifies an address error.
3412 In that case, there may also be an "add" item for the same key. Arrange
3413 that a "delete" item is dropped in favour of an "add" item. */
3416 if (!addr
) goto ADDR_MISMATCH
;
3418 DEBUG(D_deliver
|D_retry
)
3419 debug_printf("reading retry information for %s from subprocess\n",
3422 /* Cut out any "delete" items on the list. */
3424 for (rp
= &addr
->retries
; (r
= *rp
); rp
= &r
->next
)
3425 if (Ustrcmp(r
->key
, ptr
+1) == 0) /* Found item with same key */
3427 if (!(r
->flags
& rf_delete
)) break; /* It was not "delete" */
3428 *rp
= r
->next
; /* Excise a delete item */
3429 DEBUG(D_deliver
|D_retry
)
3430 debug_printf(" existing delete item dropped\n");
3433 /* We want to add a delete item only if there is no non-delete item;
3434 however we still have to step ptr through the data. */
3436 if (!r
|| !(*ptr
& rf_delete
))
3438 r
= store_get(sizeof(retry_item
), FALSE
);
3439 r
->next
= addr
->retries
;
3442 r
->key
= string_copy(ptr
);
3444 memcpy(&r
->basic_errno
, ptr
, sizeof(r
->basic_errno
));
3445 ptr
+= sizeof(r
->basic_errno
);
3446 memcpy(&r
->more_errno
, ptr
, sizeof(r
->more_errno
));
3447 ptr
+= sizeof(r
->more_errno
);
3448 r
->message
= *ptr
? string_copy(ptr
) : NULL
;
3449 DEBUG(D_deliver
|D_retry
) debug_printf(" added %s item\n",