max_parallel transport option. Bug 1698
[exim.git] / src / src / deliver.c
... / ...
CommitLineData
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
5/* Copyright (c) University of Cambridge 1995 - 2015 */
6/* See the file NOTICE for conditions of use and distribution. */
7
8/* The main code for delivering a message. */
9
10
11#include "exim.h"
12#include <assert.h>
13
14
15/* Data block for keeping track of subprocesses for parallel remote
16delivery. */
17
18typedef struct pardata {
19 address_item *addrlist; /* chain of addresses */
20 address_item *addr; /* next address data expected for */
21 pid_t pid; /* subprocess pid */
22 int fd; /* pipe fd for getting result from subprocess */
23 int transport_count; /* returned transport count value */
24 BOOL done; /* no more data needed */
25 uschar *msg; /* error message */
26 uschar *return_path; /* return_path for these addresses */
27} pardata;
28
29/* Values for the process_recipients variable */
30
31enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
32 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
33 RECIP_FAIL_LOOP};
34
35/* Mutually recursive functions for marking addresses done. */
36
37static void child_done(address_item *, uschar *);
38static void address_done(address_item *, uschar *);
39
40/* Table for turning base-62 numbers into binary */
41
42static uschar tab62[] =
43 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
44 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
45 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
46 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
47 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
48 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
49 59,60,61}; /* x-z */
50
51
52/*************************************************
53* Local static variables *
54*************************************************/
55
56/* addr_duplicate is global because it needs to be seen from the Envelope-To
57writing code. */
58
59static address_item *addr_defer = NULL;
60static address_item *addr_failed = NULL;
61static address_item *addr_fallback = NULL;
62static address_item *addr_local = NULL;
63static address_item *addr_new = NULL;
64static address_item *addr_remote = NULL;
65static address_item *addr_route = NULL;
66static address_item *addr_succeed = NULL;
67static address_item *addr_dsntmp = NULL;
68static address_item *addr_senddsn = NULL;
69
70static FILE *message_log = NULL;
71static BOOL update_spool;
72static BOOL remove_journal;
73static int parcount = 0;
74static pardata *parlist = NULL;
75static int return_count;
76static uschar *frozen_info = US"";
77static uschar *used_return_path = NULL;
78
79static uschar spoolname[PATH_MAX];
80
81
82
83/*************************************************
84* Make a new address item *
85*************************************************/
86
87/* This function gets the store and initializes with default values. The
88transport_return value defaults to DEFER, so that any unexpected failure to
89deliver does not wipe out the message. The default unique string is set to a
90copy of the address, so that its domain can be lowercased.
91
92Argument:
93 address the RFC822 address string
94 copy force a copy of the address
95
96Returns: a pointer to an initialized address_item
97*/
98
99address_item *
100deliver_make_addr(uschar *address, BOOL copy)
101{
102address_item *addr = store_get(sizeof(address_item));
103*addr = address_defaults;
104if (copy) address = string_copy(address);
105addr->address = address;
106addr->unique = string_copy(address);
107return addr;
108}
109
110
111
112
113/*************************************************
114* Set expansion values for an address *
115*************************************************/
116
117/* Certain expansion variables are valid only when handling an address or
118address list. This function sets them up or clears the values, according to its
119argument.
120
121Arguments:
122 addr the address in question, or NULL to clear values
123Returns: nothing
124*/
125
126void
127deliver_set_expansions(address_item *addr)
128{
129if (!addr)
130 {
131 const uschar ***p = address_expansions;
132 while (*p) **p++ = NULL;
133 return;
134 }
135
136/* Exactly what gets set depends on whether there is one or more addresses, and
137what they contain. These first ones are always set, taking their values from
138the first address. */
139
140if (!addr->host_list)
141 {
142 deliver_host = deliver_host_address = US"";
143 deliver_host_port = 0;
144 }
145else
146 {
147 deliver_host = addr->host_list->name;
148 deliver_host_address = addr->host_list->address;
149 deliver_host_port = addr->host_list->port;
150 }
151
152deliver_recipients = addr;
153deliver_address_data = addr->prop.address_data;
154deliver_domain_data = addr->prop.domain_data;
155deliver_localpart_data = addr->prop.localpart_data;
156
157/* These may be unset for multiple addresses */
158
159deliver_domain = addr->domain;
160self_hostname = addr->self_hostname;
161
162#ifdef EXPERIMENTAL_BRIGHTMAIL
163bmi_deliver = 1; /* deliver by default */
164bmi_alt_location = NULL;
165bmi_base64_verdict = NULL;
166bmi_base64_tracker_verdict = NULL;
167#endif
168
169/* If there's only one address we can set everything. */
170
171if (!addr->next)
172 {
173 address_item *addr_orig;
174
175 deliver_localpart = addr->local_part;
176 deliver_localpart_prefix = addr->prefix;
177 deliver_localpart_suffix = addr->suffix;
178
179 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
180 deliver_domain_orig = addr_orig->domain;
181
182 /* Re-instate any prefix and suffix in the original local part. In all
183 normal cases, the address will have a router associated with it, and we can
184 choose the caseful or caseless version accordingly. However, when a system
185 filter sets up a pipe, file, or autoreply delivery, no router is involved.
186 In this case, though, there won't be any prefix or suffix to worry about. */
187
188 deliver_localpart_orig = !addr_orig->router
189 ? addr_orig->local_part
190 : addr_orig->router->caseful_local_part
191 ? addr_orig->cc_local_part
192 : addr_orig->lc_local_part;
193
194 /* If there's a parent, make its domain and local part available, and if
195 delivering to a pipe or file, or sending an autoreply, get the local
196 part from the parent. For pipes and files, put the pipe or file string
197 into address_pipe and address_file. */
198
199 if (addr->parent)
200 {
201 deliver_domain_parent = addr->parent->domain;
202 deliver_localpart_parent = !addr->parent->router
203 ? addr->parent->local_part
204 : addr->parent->router->caseful_local_part
205 ? addr->parent->cc_local_part
206 : addr->parent->lc_local_part;
207
208 /* File deliveries have their own flag because they need to be picked out
209 as special more often. */
210
211 if (testflag(addr, af_pfr))
212 {
213 if (testflag(addr, af_file)) address_file = addr->local_part;
214 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
215 deliver_localpart = addr->parent->local_part;
216 deliver_localpart_prefix = addr->parent->prefix;
217 deliver_localpart_suffix = addr->parent->suffix;
218 }
219 }
220
221#ifdef EXPERIMENTAL_BRIGHTMAIL
222 /* Set expansion variables related to Brightmail AntiSpam */
223 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
224 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
225 /* get message delivery status (0 - don't deliver | 1 - deliver) */
226 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
227 /* if message is to be delivered, get eventual alternate location */
228 if (bmi_deliver == 1)
229 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
230#endif
231
232 }
233
234/* For multiple addresses, don't set local part, and leave the domain and
235self_hostname set only if it is the same for all of them. It is possible to
236have multiple pipe and file addresses, but only when all addresses have routed
237to the same pipe or file. */
238
239else
240 {
241 address_item *addr2;
242 if (testflag(addr, af_pfr))
243 {
244 if (testflag(addr, af_file)) address_file = addr->local_part;
245 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
246 }
247 for (addr2 = addr->next; addr2; addr2 = addr2->next)
248 {
249 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
250 deliver_domain = NULL;
251 if ( self_hostname
252 && ( !addr2->self_hostname
253 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
254 ) )
255 self_hostname = NULL;
256 if (!deliver_domain && !self_hostname) break;
257 }
258 }
259}
260
261
262
263
264/*************************************************
265* Open a msglog file *
266*************************************************/
267
268/* This function is used both for normal message logs, and for files in the
269msglog directory that are used to catch output from pipes. Try to create the
270directory if it does not exist. From release 4.21, normal message logs should
271be created when the message is received.
272
273Argument:
274 filename the file name
275 mode the mode required
276 error used for saying what failed
277
278Returns: a file descriptor, or -1 (with errno set)
279*/
280
281static int
282open_msglog_file(uschar *filename, int mode, uschar **error)
283{
284int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
285
286if (fd < 0 && errno == ENOENT)
287 {
288 uschar temp[16];
289 sprintf(CS temp, "msglog/%s", message_subdir);
290 if (message_subdir[0] == 0) temp[6] = 0;
291 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
292 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
293 }
294
295/* Set the close-on-exec flag and change the owner to the exim uid/gid (this
296function is called as root). Double check the mode, because the group setting
297doesn't always get set automatically. */
298
299if (fd >= 0)
300 {
301 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
302 if (fchown(fd, exim_uid, exim_gid) < 0)
303 {
304 *error = US"chown";
305 return -1;
306 }
307 if (fchmod(fd, mode) < 0)
308 {
309 *error = US"chmod";
310 return -1;
311 }
312 }
313else *error = US"create";
314
315return fd;
316}
317
318
319
320
321/*************************************************
322* Write to msglog if required *
323*************************************************/
324
325/* Write to the message log, if configured. This function may also be called
326from transports.
327
328Arguments:
329 format a string format
330
331Returns: nothing
332*/
333
334void
335deliver_msglog(const char *format, ...)
336{
337va_list ap;
338if (!message_logs) return;
339va_start(ap, format);
340vfprintf(message_log, format, ap);
341fflush(message_log);
342va_end(ap);
343}
344
345
346
347
348/*************************************************
349* Replicate status for batch *
350*************************************************/
351
352/* When a transport handles a batch of addresses, it may treat them
353individually, or it may just put the status in the first one, and return FALSE,
354requesting that the status be copied to all the others externally. This is the
355replication function. As well as the status, it copies the transport pointer,
356which may have changed if appendfile passed the addresses on to a different
357transport.
358
359Argument: pointer to the first address in a chain
360Returns: nothing
361*/
362
363static void
364replicate_status(address_item *addr)
365{
366address_item *addr2;
367for (addr2 = addr->next; addr2; addr2 = addr2->next)
368 {
369 addr2->transport = addr->transport;
370 addr2->transport_return = addr->transport_return;
371 addr2->basic_errno = addr->basic_errno;
372 addr2->more_errno = addr->more_errno;
373 addr2->special_action = addr->special_action;
374 addr2->message = addr->message;
375 addr2->user_message = addr->user_message;
376 }
377}
378
379
380
381/*************************************************
382* Compare lists of hosts *
383*************************************************/
384
385/* This function is given two pointers to chains of host items, and it yields
386TRUE if the lists refer to the same hosts in the same order, except that
387
388(1) Multiple hosts with the same non-negative MX values are permitted to appear
389 in different orders. Round-robinning nameservers can cause this to happen.
390
391(2) Multiple hosts with the same negative MX values less than MX_NONE are also
392 permitted to appear in different orders. This is caused by randomizing
393 hosts lists.
394
395This enables Exim to use a single SMTP transaction for sending to two entirely
396different domains that happen to end up pointing at the same hosts.
397
398Arguments:
399 one points to the first host list
400 two points to the second host list
401
402Returns: TRUE if the lists refer to the same host set
403*/
404
405static BOOL
406same_hosts(host_item *one, host_item *two)
407{
408while (one && two)
409 {
410 if (Ustrcmp(one->name, two->name) != 0)
411 {
412 int mx = one->mx;
413 host_item *end_one = one;
414 host_item *end_two = two;
415
416 /* Batch up only if there was no MX and the list was not randomized */
417
418 if (mx == MX_NONE) return FALSE;
419
420 /* Find the ends of the shortest sequence of identical MX values */
421
422 while ( end_one->next && end_one->next->mx == mx
423 && end_two->next && end_two->next->mx == mx)
424 {
425 end_one = end_one->next;
426 end_two = end_two->next;
427 }
428
429 /* If there aren't any duplicates, there's no match. */
430
431 if (end_one == one) return FALSE;
432
433 /* For each host in the 'one' sequence, check that it appears in the 'two'
434 sequence, returning FALSE if not. */
435
436 for (;;)
437 {
438 host_item *hi;
439 for (hi = two; hi != end_two->next; hi = hi->next)
440 if (Ustrcmp(one->name, hi->name) == 0) break;
441 if (hi == end_two->next) return FALSE;
442 if (one == end_one) break;
443 one = one->next;
444 }
445
446 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
447 Ensure both are pointing at the last host, and carry on as for equality. */
448
449 two = end_two;
450 }
451
452 /* Hosts matched */
453
454 one = one->next;
455 two = two->next;
456 }
457
458/* True if both are NULL */
459
460return (one == two);
461}
462
463
464
465/*************************************************
466* Compare header lines *
467*************************************************/
468
469/* This function is given two pointers to chains of header items, and it yields
470TRUE if they are the same header texts in the same order.
471
472Arguments:
473 one points to the first header list
474 two points to the second header list
475
476Returns: TRUE if the lists refer to the same header set
477*/
478
479static BOOL
480same_headers(header_line *one, header_line *two)
481{
482for (;; one = one->next, two = two->next)
483 {
484 if (one == two) return TRUE; /* Includes the case where both NULL */
485 if (!one || !two) return FALSE;
486 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
487 }
488}
489
490
491
492/*************************************************
493* Compare string settings *
494*************************************************/
495
496/* This function is given two pointers to strings, and it returns
497TRUE if they are the same pointer, or if the two strings are the same.
498
499Arguments:
500 one points to the first string
501 two points to the second string
502
503Returns: TRUE or FALSE
504*/
505
506static BOOL
507same_strings(uschar *one, uschar *two)
508{
509if (one == two) return TRUE; /* Includes the case where both NULL */
510if (!one || !two) return FALSE;
511return (Ustrcmp(one, two) == 0);
512}
513
514
515
516/*************************************************
517* Compare uid/gid for addresses *
518*************************************************/
519
520/* This function is given a transport and two addresses. It yields TRUE if the
521uid/gid/initgroups settings for the two addresses are going to be the same when
522they are delivered.
523
524Arguments:
525 tp the transort
526 addr1 the first address
527 addr2 the second address
528
529Returns: TRUE or FALSE
530*/
531
532static BOOL
533same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
534{
535if ( !tp->uid_set && !tp->expand_uid
536 && !tp->deliver_as_creator
537 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
538 || ( testflag(addr1, af_uid_set)
539 && ( addr1->uid != addr2->uid
540 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
541 ) ) ) )
542 return FALSE;
543
544if ( !tp->gid_set && !tp->expand_gid
545 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
546 || ( testflag(addr1, af_gid_set)
547 && addr1->gid != addr2->gid
548 ) ) )
549 return FALSE;
550
551return TRUE;
552}
553
554
555
556
557/*************************************************
558* Record that an address is complete *
559*************************************************/
560
561/* This function records that an address is complete. This is straightforward
562for most addresses, where the unique address is just the full address with the
563domain lower cased. For homonyms (addresses that are the same as one of their
564ancestors) their are complications. Their unique addresses have \x\ prepended
565(where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
566cousins.
567
568Exim used to record the unique addresses of homonyms as "complete". This,
569however, fails when the pattern of redirection varies over time (e.g. if taking
570unseen copies at only some times of day) because the prepended numbers may vary
571from one delivery run to the next. This problem is solved by never recording
572prepended unique addresses as complete. Instead, when a homonymic address has
573actually been delivered via a transport, we record its basic unique address
574followed by the name of the transport. This is checked in subsequent delivery
575runs whenever an address is routed to a transport.
576
577If the completed address is a top-level one (has no parent, which means it
578cannot be homonymic) we also add the original address to the non-recipients
579tree, so that it gets recorded in the spool file and therefore appears as
580"done" in any spool listings. The original address may differ from the unique
581address in the case of the domain.
582
583Finally, this function scans the list of duplicates, marks as done any that
584match this address, and calls child_done() for their ancestors.
585
586Arguments:
587 addr address item that has been completed
588 now current time as a string
589
590Returns: nothing
591*/
592
593static void
594address_done(address_item *addr, uschar *now)
595{
596address_item *dup;
597
598update_spool = TRUE; /* Ensure spool gets updated */
599
600/* Top-level address */
601
602if (!addr->parent)
603 {
604 tree_add_nonrecipient(addr->unique);
605 tree_add_nonrecipient(addr->address);
606 }
607
608/* Homonymous child address */
609
610else if (testflag(addr, af_homonym))
611 {
612 if (addr->transport)
613 tree_add_nonrecipient(
614 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
615 }
616
617/* Non-homonymous child address */
618
619else tree_add_nonrecipient(addr->unique);
620
621/* Check the list of duplicate addresses and ensure they are now marked
622done as well. */
623
624for (dup = addr_duplicate; dup; dup = dup->next)
625 if (Ustrcmp(addr->unique, dup->unique) == 0)
626 {
627 tree_add_nonrecipient(dup->unique);
628 child_done(dup, now);
629 }
630}
631
632
633
634
635/*************************************************
636* Decrease counts in parents and mark done *
637*************************************************/
638
639/* This function is called when an address is complete. If there is a parent
640address, its count of children is decremented. If there are still other
641children outstanding, the function exits. Otherwise, if the count has become
642zero, address_done() is called to mark the parent and its duplicates complete.
643Then loop for any earlier ancestors.
644
645Arguments:
646 addr points to the completed address item
647 now the current time as a string, for writing to the message log
648
649Returns: nothing
650*/
651
652static void
653child_done(address_item *addr, uschar *now)
654{
655address_item *aa;
656while (addr->parent)
657 {
658 addr = addr->parent;
659 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
660 address_done(addr, now);
661
662 /* Log the completion of all descendents only when there is no ancestor with
663 the same original address. */
664
665 for (aa = addr->parent; aa; aa = aa->parent)
666 if (Ustrcmp(aa->address, addr->address) == 0) break;
667 if (aa) continue;
668
669 deliver_msglog("%s %s: children all complete\n", now, addr->address);
670 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
671 }
672}
673
674
675
676/*************************************************
677* Delivery logging support functions *
678*************************************************/
679
680/* The LOGGING() checks in d_log_interface() are complicated for backwards
681compatibility. When outgoing interface logging was originally added, it was
682conditional on just incoming_interface (which is off by default). The
683outgoing_interface option is on by default to preserve this behaviour, but
684you can enable incoming_interface and disable outgoing_interface to get I=
685fields on incoming lines only.
686
687Arguments:
688 s The log line buffer
689 sizep Pointer to the buffer size
690 ptrp Pointer to current index into buffer
691 addr The address to be logged
692
693Returns: New value for s
694*/
695
696static uschar *
697d_log_interface(uschar *s, int *sizep, int *ptrp)
698{
699if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
700 && sending_ip_address)
701 {
702 s = string_append(s, sizep, ptrp, 2, US" I=[", sending_ip_address);
703 s = LOGGING(outgoing_port)
704 ? string_append(s, sizep, ptrp, 2, US"]:",
705 string_sprintf("%d", sending_port))
706 : string_cat(s, sizep, ptrp, "]", 1);
707 }
708return s;
709}
710
711
712
713static uschar *
714d_hostlog(uschar *s, int *sizep, int *ptrp, address_item *addr)
715{
716s = string_append(s, sizep, ptrp, 5, US" H=", addr->host_used->name,
717 US" [", addr->host_used->address, US"]");
718if (LOGGING(outgoing_port))
719 s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
720 addr->host_used->port));
721return d_log_interface(s, sizep, ptrp);
722}
723
724
725
726#ifdef SUPPORT_TLS
727static uschar *
728d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
729{
730if (LOGGING(tls_cipher) && addr->cipher)
731 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
732if (LOGGING(tls_certificate_verified) && addr->cipher)
733 s = string_append(s, sizep, ptrp, 2, US" CV=",
734 testflag(addr, af_cert_verified)
735 ?
736#ifdef EXPERIMENTAL_DANE
737 testflag(addr, af_dane_verified)
738 ? "dane"
739 :
740#endif
741 "yes"
742 : "no");
743if (LOGGING(tls_peerdn) && addr->peerdn)
744 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
745 string_printing(addr->peerdn), US"\"");
746return s;
747}
748#endif
749
750
751
752
753#ifdef EXPERIMENTAL_EVENT
754uschar *
755event_raise(uschar * action, const uschar * event, uschar * ev_data)
756{
757uschar * s;
758if (action)
759 {
760 DEBUG(D_deliver)
761 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
762 event,
763 action, deliver_host_address);
764
765 event_name = event;
766 event_data = ev_data;
767
768 if (!(s = expand_string(action)) && *expand_string_message)
769 log_write(0, LOG_MAIN|LOG_PANIC,
770 "failed to expand event_action %s in %s: %s\n",
771 event, transport_name, expand_string_message);
772
773 event_name = event_data = NULL;
774
775 /* If the expansion returns anything but an empty string, flag for
776 the caller to modify his normal processing
777 */
778 if (s && *s)
779 {
780 DEBUG(D_deliver)
781 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
782 return s;
783 }
784 }
785return NULL;
786}
787
788static void
789msg_event_raise(const uschar * event, const address_item * addr)
790{
791const uschar * save_domain = deliver_domain;
792uschar * save_local = deliver_localpart;
793const uschar * save_host = deliver_host;
794
795if (!addr->transport)
796 return;
797
798router_name = addr->router ? addr->router->name : NULL;
799transport_name = addr->transport->name;
800deliver_domain = addr->domain;
801deliver_localpart = addr->local_part;
802deliver_host = addr->host_used ? addr->host_used->name : NULL;
803
804(void) event_raise(addr->transport->event_action, event,
805 addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
806 ? addr->message : NULL);
807
808deliver_host = save_host;
809deliver_localpart = save_local;
810deliver_domain = save_domain;
811router_name = transport_name = NULL;
812}
813#endif /*EXPERIMENTAL_EVENT*/
814
815
816
817/* If msg is NULL this is a delivery log and logchar is used. Otherwise
818this is a nonstandard call; no two-character delivery flag is written
819but sender-host and sender are prefixed and "msg" is inserted in the log line.
820
821Arguments:
822 flags passed to log_write()
823*/
824void
825delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
826{
827uschar *log_address;
828int size = 256; /* Used for a temporary, */
829int ptr = 0; /* expanding buffer, for */
830uschar *s; /* building log lines; */
831void *reset_point; /* released afterwards. */
832
833/* Log the delivery on the main log. We use an extensible string to build up
834the log line, and reset the store afterwards. Remote deliveries should always
835have a pointer to the host item that succeeded; local deliveries can have a
836pointer to a single host item in their host list, for use by the transport. */
837
838#ifdef EXPERIMENTAL_EVENT
839 /* presume no successful remote delivery */
840 lookup_dnssec_authenticated = NULL;
841#endif
842
843s = reset_point = store_get(size);
844
845log_address = string_log_address(addr, LOGGING(all_parents), TRUE);
846if (msg)
847 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
848else
849 {
850 s[ptr++] = logchar;
851 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
852 }
853
854if (LOGGING(sender_on_delivery) || msg)
855 s = string_append(s, &size, &ptr, 3, US" F=<",
856#ifdef EXPERIMENTAL_INTERNATIONAL
857 testflag(addr, af_utf8_downcvt)
858 ? string_address_utf8_to_alabel(sender_address, NULL)
859 :
860#endif
861 sender_address,
862 US">");
863
864#ifdef EXPERIMENTAL_SRS
865if(addr->prop.srs_sender)
866 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->prop.srs_sender, US">");
867#endif
868
869/* You might think that the return path must always be set for a successful
870delivery; indeed, I did for some time, until this statement crashed. The case
871when it is not set is for a delivery to /dev/null which is optimised by not
872being run at all. */
873
874if (used_return_path && LOGGING(return_path_on_delivery))
875 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
876
877if (msg)
878 s = string_append(s, &size, &ptr, 2, US" ", msg);
879
880/* For a delivery from a system filter, there may not be a router */
881if (addr->router)
882 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
883
884s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
885
886if (LOGGING(delivery_size))
887 s = string_append(s, &size, &ptr, 2, US" S=",
888 string_sprintf("%d", transport_count));
889
890/* Local delivery */
891
892if (addr->transport->info->local)
893 {
894 if (addr->host_list)
895 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
896 s = d_log_interface(s, &size, &ptr);
897 if (addr->shadow_message)
898 s = string_cat(s, &size, &ptr, addr->shadow_message,
899 Ustrlen(addr->shadow_message));
900 }
901
902/* Remote delivery */
903
904else
905 {
906 if (addr->host_used)
907 {
908 s = d_hostlog(s, &size, &ptr, addr);
909 if (continue_sequence > 1)
910 s = string_cat(s, &size, &ptr, US"*", 1);
911
912#ifdef EXPERIMENTAL_EVENT
913 deliver_host_address = addr->host_used->address;
914 deliver_host_port = addr->host_used->port;
915 deliver_host = addr->host_used->name;
916
917 /* DNS lookup status */
918 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
919 : addr->host_used->dnssec==DS_NO ? US"no"
920 : NULL;
921#endif
922 }
923
924#ifdef SUPPORT_TLS
925 s = d_tlslog(s, &size, &ptr, addr);
926#endif
927
928 if (addr->authenticator)
929 {
930 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
931 if (addr->auth_id)
932 {
933 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
934 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
935 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
936 }
937 }
938
939#ifndef DISABLE_PRDR
940 if (addr->flags & af_prdr_used)
941 s = string_append(s, &size, &ptr, 1, US" PRDR");
942#endif
943 }
944
945/* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
946
947if ( LOGGING(smtp_confirmation)
948 && addr->message
949 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
950 )
951 {
952 unsigned i;
953 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
954 uschar *p = big_buffer;
955 uschar *ss = addr->message;
956 *p++ = '\"';
957 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
958 {
959 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
960 *p++ = ss[i];
961 }
962 *p++ = '\"';
963 *p = 0;
964 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
965 }
966
967/* Time on queue and actual time taken to deliver */
968
969if (LOGGING(queue_time))
970 s = string_append(s, &size, &ptr, 2, US" QT=",
971 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
972
973if (LOGGING(deliver_time))
974 s = string_append(s, &size, &ptr, 2, US" DT=",
975 readconf_printtime(addr->more_errno));
976
977/* string_cat() always leaves room for the terminator. Release the
978store we used to build the line after writing it. */
979
980s[ptr] = 0;
981log_write(0, flags, "%s", s);
982
983#ifdef EXPERIMENTAL_EVENT
984if (!msg) msg_event_raise(US"msg:delivery", addr);
985#endif
986
987store_reset(reset_point);
988return;
989}
990
991
992
993/*************************************************
994* Actions at the end of handling an address *
995*************************************************/
996
997/* This is a function for processing a single address when all that can be done
998with it has been done.
999
1000Arguments:
1001 addr points to the address block
1002 result the result of the delivery attempt
1003 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1004 driver_type indicates which type of driver (transport, or router) was last
1005 to process the address
1006 logchar '=' or '-' for use when logging deliveries with => or ->
1007
1008Returns: nothing
1009*/
1010
1011static void
1012post_process_one(address_item *addr, int result, int logflags, int driver_type,
1013 int logchar)
1014{
1015uschar *now = tod_stamp(tod_log);
1016uschar *driver_kind = NULL;
1017uschar *driver_name = NULL;
1018uschar *log_address;
1019
1020int size = 256; /* Used for a temporary, */
1021int ptr = 0; /* expanding buffer, for */
1022uschar *s; /* building log lines; */
1023void *reset_point; /* released afterwards. */
1024
1025DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1026
1027/* Set up driver kind and name for logging. Disable logging if the router or
1028transport has disabled it. */
1029
1030if (driver_type == DTYPE_TRANSPORT)
1031 {
1032 if (addr->transport)
1033 {
1034 driver_name = addr->transport->name;
1035 driver_kind = US" transport";
1036 disable_logging = addr->transport->disable_logging;
1037 }
1038 else driver_kind = US"transporting";
1039 }
1040else if (driver_type == DTYPE_ROUTER)
1041 {
1042 if (addr->router)
1043 {
1044 driver_name = addr->router->name;
1045 driver_kind = US" router";
1046 disable_logging = addr->router->disable_logging;
1047 }
1048 else driver_kind = US"routing";
1049 }
1050
1051/* If there's an error message set, ensure that it contains only printing
1052characters - it should, but occasionally things slip in and this at least
1053stops the log format from getting wrecked. We also scan the message for an LDAP
1054expansion item that has a password setting, and flatten the password. This is a
1055fudge, but I don't know a cleaner way of doing this. (If the item is badly
1056malformed, it won't ever have gone near LDAP.) */
1057
1058if (addr->message)
1059 {
1060 const uschar * s = string_printing(addr->message);
1061 if (s != addr->message)
1062 addr->message = US s;
1063 /* deconst cast ok as string_printing known to have alloc'n'copied */
1064 if ( ( Ustrstr(s, "failed to expand") != NULL
1065 || Ustrstr(s, "expansion of ") != NULL
1066 )
1067 && ( Ustrstr(s, "mysql") != NULL
1068 || Ustrstr(s, "pgsql") != NULL
1069#ifdef EXPERIMENTAL_REDIS
1070 || Ustrstr(s, "redis") != NULL
1071#endif
1072 || Ustrstr(s, "sqlite") != NULL
1073 || Ustrstr(s, "ldap:") != NULL
1074 || Ustrstr(s, "ldapdn:") != NULL
1075 || Ustrstr(s, "ldapm:") != NULL
1076 ) )
1077 addr->message = string_sprintf("Temporary internal error");
1078 }
1079
1080/* If we used a transport that has one of the "return_output" options set, and
1081if it did in fact generate some output, then for return_output we treat the
1082message as failed if it was not already set that way, so that the output gets
1083returned to the sender, provided there is a sender to send it to. For
1084return_fail_output, do this only if the delivery failed. Otherwise we just
1085unlink the file, and remove the name so that if the delivery failed, we don't
1086try to send back an empty or unwanted file. The log_output options operate only
1087on a non-empty file.
1088
1089In any case, we close the message file, because we cannot afford to leave a
1090file-descriptor for one address while processing (maybe very many) others. */
1091
1092if (addr->return_file >= 0 && addr->return_filename)
1093 {
1094 BOOL return_output = FALSE;
1095 struct stat statbuf;
1096 (void)EXIMfsync(addr->return_file);
1097
1098 /* If there is no output, do nothing. */
1099
1100 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1101 {
1102 transport_instance *tb = addr->transport;
1103
1104 /* Handle logging options */
1105
1106 if ( tb->log_output
1107 || result == FAIL && tb->log_fail_output
1108 || result == DEFER && tb->log_defer_output
1109 )
1110 {
1111 uschar *s;
1112 FILE *f = Ufopen(addr->return_filename, "rb");
1113 if (!f)
1114 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1115 "from %s transport: %s", addr->return_filename, tb->name,
1116 strerror(errno));
1117 else
1118 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1119 {
1120 uschar *p = big_buffer + Ustrlen(big_buffer);
1121 const uschar * sp;
1122 while (p > big_buffer && isspace(p[-1])) p--;
1123 *p = 0;
1124 sp = string_printing(big_buffer);
1125 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1126 addr->address, tb->name, sp);
1127 }
1128 (void)fclose(f);
1129 }
1130
1131 /* Handle returning options, but only if there is an address to return
1132 the text to. */
1133
1134 if (sender_address[0] != 0 || addr->prop.errors_address)
1135 if (tb->return_output)
1136 {
1137 addr->transport_return = result = FAIL;
1138 if (addr->basic_errno == 0 && !addr->message)
1139 addr->message = US"return message generated";
1140 return_output = TRUE;
1141 }
1142 else
1143 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1144 }
1145
1146 /* Get rid of the file unless it might be returned, but close it in
1147 all cases. */
1148
1149 if (!return_output)
1150 {
1151 Uunlink(addr->return_filename);
1152 addr->return_filename = NULL;
1153 addr->return_file = -1;
1154 }
1155
1156 (void)close(addr->return_file);
1157 }
1158
1159/* The success case happens only after delivery by a transport. */
1160
1161if (result == OK)
1162 {
1163 addr->next = addr_succeed;
1164 addr_succeed = addr;
1165
1166 /* Call address_done() to ensure that we don't deliver to this address again,
1167 and write appropriate things to the message log. If it is a child address, we
1168 call child_done() to scan the ancestors and mark them complete if this is the
1169 last child to complete. */
1170
1171 address_done(addr, now);
1172 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1173
1174 if (!addr->parent)
1175 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1176 driver_name, driver_kind);
1177 else
1178 {
1179 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1180 addr->parent->address, driver_name, driver_kind);
1181 child_done(addr, now);
1182 }
1183
1184 /* Certificates for logging (via events) */
1185#ifdef SUPPORT_TLS
1186 tls_out.ourcert = addr->ourcert;
1187 addr->ourcert = NULL;
1188 tls_out.peercert = addr->peercert;
1189 addr->peercert = NULL;
1190
1191 tls_out.cipher = addr->cipher;
1192 tls_out.peerdn = addr->peerdn;
1193 tls_out.ocsp = addr->ocsp;
1194# ifdef EXPERIMENTAL_DANE
1195 tls_out.dane_verified = testflag(addr, af_dane_verified);
1196# endif
1197#endif
1198
1199 delivery_log(LOG_MAIN, addr, logchar, NULL);
1200
1201#ifdef SUPPORT_TLS
1202 tls_free_cert(&tls_out.ourcert);
1203 tls_free_cert(&tls_out.peercert);
1204 tls_out.cipher = NULL;
1205 tls_out.peerdn = NULL;
1206 tls_out.ocsp = OCSP_NOT_REQ;
1207# ifdef EXPERIMENTAL_DANE
1208 tls_out.dane_verified = FALSE;
1209# endif
1210#endif
1211 }
1212
1213
1214/* Soft failure, or local delivery process failed; freezing may be
1215requested. */
1216
1217else if (result == DEFER || result == PANIC)
1218 {
1219 if (result == PANIC) logflags |= LOG_PANIC;
1220
1221 /* This puts them on the chain in reverse order. Do not change this, because
1222 the code for handling retries assumes that the one with the retry
1223 information is last. */
1224
1225 addr->next = addr_defer;
1226 addr_defer = addr;
1227
1228 /* The only currently implemented special action is to freeze the
1229 message. Logging of this is done later, just before the -H file is
1230 updated. */
1231
1232 if (addr->special_action == SPECIAL_FREEZE)
1233 {
1234 deliver_freeze = TRUE;
1235 deliver_frozen_at = time(NULL);
1236 update_spool = TRUE;
1237 }
1238
1239 /* If doing a 2-stage queue run, we skip writing to either the message
1240 log or the main log for SMTP defers. */
1241
1242 if (!queue_2stage || addr->basic_errno != 0)
1243 {
1244 uschar ss[32];
1245
1246 /* For errors of the type "retry time not reached" (also remotes skipped
1247 on queue run), logging is controlled by L_retry_defer. Note that this kind
1248 of error number is negative, and all the retry ones are less than any
1249 others. */
1250
1251 unsigned int use_log_selector = addr->basic_errno <= ERRNO_RETRY_BASE
1252 ? L_retry_defer : 0;
1253
1254 /* Build up the line that is used for both the message log and the main
1255 log. */
1256
1257 s = reset_point = store_get(size);
1258
1259 /* Create the address string for logging. Must not do this earlier, because
1260 an OK result may be changed to FAIL when a pipe returns text. */
1261
1262 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1263
1264 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1265
1266 /* Either driver_name contains something and driver_kind contains
1267 " router" or " transport" (note the leading space), or driver_name is
1268 a null string and driver_kind contains "routing" without the leading
1269 space, if all routing has been deferred. When a domain has been held,
1270 so nothing has been done at all, both variables contain null strings. */
1271
1272 if (driver_name)
1273 {
1274 if (driver_kind[1] == 't' && addr->router)
1275 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1276 Ustrcpy(ss, " ?=");
1277 ss[1] = toupper(driver_kind[1]);
1278 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1279 }
1280 else if (driver_kind)
1281 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1282
1283 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1284 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1285
1286 if (addr->basic_errno > 0)
1287 s = string_append(s, &size, &ptr, 2, US": ",
1288 US strerror(addr->basic_errno));
1289
1290 if (addr->host_used)
1291 s = string_append(s, &size, &ptr, 5,
1292 US" H=", addr->host_used->name,
1293 US" [", addr->host_used->address, US"]");
1294
1295 if (addr->message)
1296 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1297
1298 s[ptr] = 0;
1299
1300 /* Log the deferment in the message log, but don't clutter it
1301 up with retry-time defers after the first delivery attempt. */
1302
1303 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1304 deliver_msglog("%s %s\n", now, s);
1305
1306 /* Write the main log and reset the store */
1307
1308 log_write(use_log_selector, logflags, "== %s", s);
1309 store_reset(reset_point);
1310 }
1311 }
1312
1313
1314/* Hard failure. If there is an address to which an error message can be sent,
1315put this address on the failed list. If not, put it on the deferred list and
1316freeze the mail message for human attention. The latter action can also be
1317explicitly requested by a router or transport. */
1318
1319else
1320 {
1321 /* If this is a delivery error, or a message for which no replies are
1322 wanted, and the message's age is greater than ignore_bounce_errors_after,
1323 force the af_ignore_error flag. This will cause the address to be discarded
1324 later (with a log entry). */
1325
1326 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1327 setflag(addr, af_ignore_error);
1328
1329 /* Freeze the message if requested, or if this is a bounce message (or other
1330 message with null sender) and this address does not have its own errors
1331 address. However, don't freeze if errors are being ignored. The actual code
1332 to ignore occurs later, instead of sending a message. Logging of freezing
1333 occurs later, just before writing the -H file. */
1334
1335 if ( !testflag(addr, af_ignore_error)
1336 && ( addr->special_action == SPECIAL_FREEZE
1337 || (sender_address[0] == 0 && !addr->prop.errors_address)
1338 ) )
1339 {
1340 frozen_info = addr->special_action == SPECIAL_FREEZE
1341 ? US""
1342 : sender_local && !local_error_message
1343 ? US" (message created with -f <>)"
1344 : US" (delivery error message)";
1345 deliver_freeze = TRUE;
1346 deliver_frozen_at = time(NULL);
1347 update_spool = TRUE;
1348
1349 /* The address is put on the defer rather than the failed queue, because
1350 the message is being retained. */
1351
1352 addr->next = addr_defer;
1353 addr_defer = addr;
1354 }
1355
1356 /* Don't put the address on the nonrecipients tree yet; wait until an
1357 error message has been successfully sent. */
1358
1359 else
1360 {
1361 addr->next = addr_failed;
1362 addr_failed = addr;
1363 }
1364
1365 /* Build up the log line for the message and main logs */
1366
1367 s = reset_point = store_get(size);
1368
1369 /* Create the address string for logging. Must not do this earlier, because
1370 an OK result may be changed to FAIL when a pipe returns text. */
1371
1372 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1373
1374 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1375
1376 if (LOGGING(sender_on_delivery))
1377 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1378
1379 /* Return path may not be set if no delivery actually happened */
1380
1381 if (used_return_path && LOGGING(return_path_on_delivery))
1382 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1383
1384 if (addr->router)
1385 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1386 if (addr->transport)
1387 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1388
1389 if (addr->host_used)
1390 s = d_hostlog(s, &size, &ptr, addr);
1391
1392#ifdef SUPPORT_TLS
1393 s = d_tlslog(s, &size, &ptr, addr);
1394#endif
1395
1396 if (addr->basic_errno > 0)
1397 s = string_append(s, &size, &ptr, 2, US": ",
1398 US strerror(addr->basic_errno));
1399
1400 if (addr->message)
1401 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1402
1403 s[ptr] = 0;
1404
1405 /* Do the logging. For the message log, "routing failed" for those cases,
1406 just to make it clearer. */
1407
1408 if (driver_name)
1409 deliver_msglog("%s %s\n", now, s);
1410 else
1411 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1412
1413 log_write(0, LOG_MAIN, "** %s", s);
1414
1415#ifdef EXPERIMENTAL_EVENT
1416 msg_event_raise(US"msg:fail:delivery", addr);
1417#endif
1418
1419 store_reset(reset_point);
1420 }
1421
1422/* Ensure logging is turned on again in all cases */
1423
1424disable_logging = FALSE;
1425}
1426
1427
1428
1429
1430/*************************************************
1431* Address-independent error *
1432*************************************************/
1433
1434/* This function is called when there's an error that is not dependent on a
1435particular address, such as an expansion string failure. It puts the error into
1436all the addresses in a batch, logs the incident on the main and panic logs, and
1437clears the expansions. It is mostly called from local_deliver(), but can be
1438called for a remote delivery via findugid().
1439
1440Arguments:
1441 logit TRUE if (MAIN+PANIC) logging required
1442 addr the first of the chain of addresses
1443 code the error code
1444 format format string for error message, or NULL if already set in addr
1445 ... arguments for the format
1446
1447Returns: nothing
1448*/
1449
1450static void
1451common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1452{
1453address_item *addr2;
1454addr->basic_errno = code;
1455
1456if (format)
1457 {
1458 va_list ap;
1459 uschar buffer[512];
1460 va_start(ap, format);
1461 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1462 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1463 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1464 va_end(ap);
1465 addr->message = string_copy(buffer);
1466 }
1467
1468for (addr2 = addr->next; addr2; addr2 = addr2->next)
1469 {
1470 addr2->basic_errno = code;
1471 addr2->message = addr->message;
1472 }
1473
1474if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1475deliver_set_expansions(NULL);
1476}
1477
1478
1479
1480
1481/*************************************************
1482* Check a "never users" list *
1483*************************************************/
1484
1485/* This function is called to check whether a uid is on one of the two "never
1486users" lists.
1487
1488Arguments:
1489 uid the uid to be checked
1490 nusers the list to be scanned; the first item in the list is the count
1491
1492Returns: TRUE if the uid is on the list
1493*/
1494
1495static BOOL
1496check_never_users(uid_t uid, uid_t *nusers)
1497{
1498int i;
1499if (!nusers) return FALSE;
1500for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1501return FALSE;
1502}
1503
1504
1505
1506/*************************************************
1507* Find uid and gid for a transport *
1508*************************************************/
1509
1510/* This function is called for both local and remote deliveries, to find the
1511uid/gid under which to run the delivery. The values are taken preferentially
1512from the transport (either explicit or deliver_as_creator), then from the
1513address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1514the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1515panic error is logged, and the function fails (which normally leads to delivery
1516deferral).
1517
1518Arguments:
1519 addr the address (possibly a chain)
1520 tp the transport
1521 uidp pointer to uid field
1522 gidp pointer to gid field
1523 igfp pointer to the use_initgroups field
1524
1525Returns: FALSE if failed - error has been set in address(es)
1526*/
1527
1528static BOOL
1529findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1530 BOOL *igfp)
1531{
1532uschar *nuname;
1533BOOL gid_set = FALSE;
1534
1535/* Default initgroups flag comes from the transport */
1536
1537*igfp = tp->initgroups;
1538
1539/* First see if there's a gid on the transport, either fixed or expandable.
1540The expanding function always logs failure itself. */
1541
1542if (tp->gid_set)
1543 {
1544 *gidp = tp->gid;
1545 gid_set = TRUE;
1546 }
1547else if (tp->expand_gid)
1548 {
1549 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1550 &(addr->message)))
1551 {
1552 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1553 return FALSE;
1554 }
1555 gid_set = TRUE;
1556 }
1557
1558/* If the transport did not set a group, see if the router did. */
1559
1560if (!gid_set && testflag(addr, af_gid_set))
1561 {
1562 *gidp = addr->gid;
1563 gid_set = TRUE;
1564 }
1565
1566/* Pick up a uid from the transport if one is set. */
1567
1568if (tp->uid_set) *uidp = tp->uid;
1569
1570/* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1571it does not provide a passwd value from which a gid can be taken. */
1572
1573else if (tp->expand_uid)
1574 {
1575 struct passwd *pw;
1576 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1577 uidp, &(addr->message)))
1578 {
1579 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1580 return FALSE;
1581 }
1582 if (!gid_set && pw)
1583 {
1584 *gidp = pw->pw_gid;
1585 gid_set = TRUE;
1586 }
1587 }
1588
1589/* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1590
1591else if (tp->deliver_as_creator)
1592 {
1593 *uidp = originator_uid;
1594 if (!gid_set)
1595 {
1596 *gidp = originator_gid;
1597 gid_set = TRUE;
1598 }
1599 }
1600
1601/* Otherwise see if the address specifies the uid and if so, take it and its
1602initgroups flag. */
1603
1604else if (testflag(addr, af_uid_set))
1605 {
1606 *uidp = addr->uid;
1607 *igfp = testflag(addr, af_initgroups);
1608 }
1609
1610/* Nothing has specified the uid - default to the Exim user, and group if the
1611gid is not set. */
1612
1613else
1614 {
1615 *uidp = exim_uid;
1616 if (!gid_set)
1617 {
1618 *gidp = exim_gid;
1619 gid_set = TRUE;
1620 }
1621 }
1622
1623/* If no gid is set, it is a disaster. We default to the Exim gid only if
1624defaulting to the Exim uid. In other words, if the configuration has specified
1625a uid, it must also provide a gid. */
1626
1627if (!gid_set)
1628 {
1629 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1630 "%s transport", tp->name);
1631 return FALSE;
1632 }
1633
1634/* Check that the uid is not on the lists of banned uids that may not be used
1635for delivery processes. */
1636
1637nuname = check_never_users(*uidp, never_users)
1638 ? US"never_users"
1639 : check_never_users(*uidp, fixed_never_users)
1640 ? US"fixed_never_users"
1641 : NULL;
1642if (nuname)
1643 {
1644 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1645 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1646 return FALSE;
1647 }
1648
1649/* All is well */
1650
1651return TRUE;
1652}
1653
1654
1655
1656
1657/*************************************************
1658* Check the size of a message for a transport *
1659*************************************************/
1660
1661/* Checks that the message isn't too big for the selected transport.
1662This is called only when it is known that the limit is set.
1663
1664Arguments:
1665 tp the transport
1666 addr the (first) address being delivered
1667
1668Returns: OK
1669 DEFER expansion failed or did not yield an integer
1670 FAIL message too big
1671*/
1672
1673int
1674check_message_size(transport_instance *tp, address_item *addr)
1675{
1676int rc = OK;
1677int size_limit;
1678
1679deliver_set_expansions(addr);
1680size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1681deliver_set_expansions(NULL);
1682
1683if (expand_string_message)
1684 {
1685 rc = DEFER;
1686 addr->message = size_limit == -1
1687 ? string_sprintf("failed to expand message_size_limit "
1688 "in %s transport: %s", tp->name, expand_string_message)
1689 : string_sprintf("invalid message_size_limit "
1690 "in %s transport: %s", tp->name, expand_string_message);
1691 }
1692else if (size_limit > 0 && message_size > size_limit)
1693 {
1694 rc = FAIL;
1695 addr->message =
1696 string_sprintf("message is too big (transport limit = %d)",
1697 size_limit);
1698 }
1699
1700return rc;
1701}
1702
1703
1704
1705/*************************************************
1706* Transport-time check for a previous delivery *
1707*************************************************/
1708
1709/* Check that this base address hasn't previously been delivered to its routed
1710transport. If it has been delivered, mark it done. The check is necessary at
1711delivery time in order to handle homonymic addresses correctly in cases where
1712the pattern of redirection changes between delivery attempts (so the unique
1713fields change). Non-homonymic previous delivery is detected earlier, at routing
1714time (which saves unnecessary routing).
1715
1716Arguments:
1717 addr the address item
1718 testing TRUE if testing wanted only, without side effects
1719
1720Returns: TRUE if previously delivered by the transport
1721*/
1722
1723static BOOL
1724previously_transported(address_item *addr, BOOL testing)
1725{
1726(void)string_format(big_buffer, big_buffer_size, "%s/%s",
1727 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1728
1729if (tree_search(tree_nonrecipients, big_buffer) != 0)
1730 {
1731 DEBUG(D_deliver|D_route|D_transport)
1732 debug_printf("%s was previously delivered (%s transport): discarded\n",
1733 addr->address, addr->transport->name);
1734 if (!testing) child_done(addr, tod_stamp(tod_log));
1735 return TRUE;
1736 }
1737
1738return FALSE;
1739}
1740
1741
1742
1743/******************************************************
1744* Check for a given header in a header string *
1745******************************************************/
1746
1747/* This function is used when generating quota warnings. The configuration may
1748specify any header lines it likes in quota_warn_message. If certain of them are
1749missing, defaults are inserted, so we need to be able to test for the presence
1750of a given header.
1751
1752Arguments:
1753 hdr the required header name
1754 hstring the header string
1755
1756Returns: TRUE the header is in the string
1757 FALSE the header is not in the string
1758*/
1759
1760static BOOL
1761contains_header(uschar *hdr, uschar *hstring)
1762{
1763int len = Ustrlen(hdr);
1764uschar *p = hstring;
1765while (*p != 0)
1766 {
1767 if (strncmpic(p, hdr, len) == 0)
1768 {
1769 p += len;
1770 while (*p == ' ' || *p == '\t') p++;
1771 if (*p == ':') return TRUE;
1772 }
1773 while (*p != 0 && *p != '\n') p++;
1774 if (*p == '\n') p++;
1775 }
1776return FALSE;
1777}
1778
1779
1780
1781
1782/*************************************************
1783* Perform a local delivery *
1784*************************************************/
1785
1786/* Each local delivery is performed in a separate process which sets its
1787uid and gid as specified. This is a safer way than simply changing and
1788restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1789used safely. From release 4, Exim no longer makes any use of it. Besides, not
1790all systems have seteuid().
1791
1792If the uid/gid are specified in the transport_instance, they are used; the
1793transport initialization must ensure that either both or neither are set.
1794Otherwise, the values associated with the address are used. If neither are set,
1795it is a configuration error.
1796
1797The transport or the address may specify a home directory (transport over-
1798rides), and if they do, this is set as $home. If neither have set a working
1799directory, this value is used for that as well. Otherwise $home is left unset
1800and the cwd is set to "/" - a directory that should be accessible to all users.
1801
1802Using a separate process makes it more complicated to get error information
1803back. We use a pipe to pass the return code and also an error code and error
1804text string back to the parent process.
1805
1806Arguments:
1807 addr points to an address block for this delivery; for "normal" local
1808 deliveries this is the only address to be delivered, but for
1809 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1810 a number of addresses can be handled simultaneously, and in this
1811 case addr will point to a chain of addresses with the same
1812 characteristics.
1813
1814 shadowing TRUE if running a shadow transport; this causes output from pipes
1815 to be ignored.
1816
1817Returns: nothing
1818*/
1819
1820static void
1821deliver_local(address_item *addr, BOOL shadowing)
1822{
1823BOOL use_initgroups;
1824uid_t uid;
1825gid_t gid;
1826int status, len, rc;
1827int pfd[2];
1828pid_t pid;
1829uschar *working_directory;
1830address_item *addr2;
1831transport_instance *tp = addr->transport;
1832
1833/* Set up the return path from the errors or sender address. If the transport
1834has its own return path setting, expand it and replace the existing value. */
1835
1836if(addr->prop.errors_address)
1837 return_path = addr->prop.errors_address;
1838#ifdef EXPERIMENTAL_SRS
1839else if (addr->prop.srs_sender)
1840 return_path = addr->prop.srs_sender;
1841#endif
1842else
1843 return_path = sender_address;
1844
1845if (tp->return_path)
1846 {
1847 uschar *new_return_path = expand_string(tp->return_path);
1848 if (!new_return_path)
1849 {
1850 if (!expand_string_forcedfail)
1851 {
1852 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1853 US"Failed to expand return path \"%s\" in %s transport: %s",
1854 tp->return_path, tp->name, expand_string_message);
1855 return;
1856 }
1857 }
1858 else return_path = new_return_path;
1859 }
1860
1861/* For local deliveries, one at a time, the value used for logging can just be
1862set directly, once and for all. */
1863
1864used_return_path = return_path;
1865
1866/* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1867gets put into the address(es), and the expansions are unset, so we can just
1868return. */
1869
1870if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1871
1872/* See if either the transport or the address specifies a home directory. A
1873home directory set in the address may already be expanded; a flag is set to
1874indicate that. In other cases we must expand it. */
1875
1876if ( (deliver_home = tp->home_dir) /* Set in transport, or */
1877 || ( (deliver_home = addr->home_dir) /* Set in address and */
1878 && !testflag(addr, af_home_expanded) /* not expanded */
1879 ) )
1880 {
1881 uschar *rawhome = deliver_home;
1882 deliver_home = NULL; /* in case it contains $home */
1883 if (!(deliver_home = expand_string(rawhome)))
1884 {
1885 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1886 "to expand for %s transport: %s", rawhome, tp->name,
1887 expand_string_message);
1888 return;
1889 }
1890 if (*deliver_home != '/')
1891 {
1892 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1893 "is not absolute for %s transport", deliver_home, tp->name);
1894 return;
1895 }
1896 }
1897
1898/* See if either the transport or the address specifies a current directory,
1899and if so, expand it. If nothing is set, use the home directory, unless it is
1900also unset in which case use "/", which is assumed to be a directory to which
1901all users have access. It is necessary to be in a visible directory for some
1902operating systems when running pipes, as some commands (e.g. "rm" under Solaris
19032.5) require this. */
1904
1905working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
1906if (working_directory)
1907 {
1908 uschar *raw = working_directory;
1909 if (!(working_directory = expand_string(raw)))
1910 {
1911 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1912 "failed to expand for %s transport: %s", raw, tp->name,
1913 expand_string_message);
1914 return;
1915 }
1916 if (*working_directory != '/')
1917 {
1918 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1919 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1920 return;
1921 }
1922 }
1923else working_directory = deliver_home ? deliver_home : US"/";
1924
1925/* If one of the return_output flags is set on the transport, create and open a
1926file in the message log directory for the transport to write its output onto.
1927This is mainly used by pipe transports. The file needs to be unique to the
1928address. This feature is not available for shadow transports. */
1929
1930if ( !shadowing
1931 && ( tp->return_output || tp->return_fail_output
1932 || tp->log_output || tp->log_fail_output
1933 ) )
1934 {
1935 uschar *error;
1936 addr->return_filename =
1937 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1938 message_id, getpid(), return_count++);
1939 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1940 if (addr->return_file < 0)
1941 {
1942 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1943 "to return message: %s", error, tp->name, strerror(errno));
1944 return;
1945 }
1946 }
1947
1948/* Create the pipe for inter-process communication. */
1949
1950if (pipe(pfd) != 0)
1951 {
1952 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1953 strerror(errno));
1954 return;
1955 }
1956
1957/* Now fork the process to do the real work in the subprocess, but first
1958ensure that all cached resources are freed so that the subprocess starts with
1959a clean slate and doesn't interfere with the parent process. */
1960
1961search_tidyup();
1962
1963if ((pid = fork()) == 0)
1964 {
1965 BOOL replicate = TRUE;
1966
1967 /* Prevent core dumps, as we don't want them in users' home directories.
1968 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1969 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1970 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1971 complain if the error is "not supported".
1972
1973 There are two scenarios where changing the max limit has an effect. In one,
1974 the user is using a .forward and invoking a command of their choice via pipe;
1975 for these, we do need the max limit to be 0 unless the admin chooses to
1976 permit an increased limit. In the other, the command is invoked directly by
1977 the transport and is under administrator control, thus being able to raise
1978 the limit aids in debugging. So there's no general always-right answer.
1979
1980 Thus we inhibit core-dumps completely but let individual transports, while
1981 still root, re-raise the limits back up to aid debugging. We make the
1982 default be no core-dumps -- few enough people can use core dumps in
1983 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1984 */
1985
1986#ifdef RLIMIT_CORE
1987 struct rlimit rl;
1988 rl.rlim_cur = 0;
1989 rl.rlim_max = 0;
1990 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1991 {
1992# ifdef SETRLIMIT_NOT_SUPPORTED
1993 if (errno != ENOSYS && errno != ENOTSUP)
1994# endif
1995 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1996 strerror(errno));
1997 }
1998#endif
1999
2000 /* Reset the random number generator, so different processes don't all
2001 have the same sequence. */
2002
2003 random_seed = 0;
2004
2005 /* If the transport has a setup entry, call this first, while still
2006 privileged. (Appendfile uses this to expand quota, for example, while
2007 able to read private files.) */
2008
2009 if (addr->transport->setup)
2010 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2011 &(addr->message)))
2012 {
2013 case DEFER:
2014 addr->transport_return = DEFER;
2015 goto PASS_BACK;
2016
2017 case FAIL:
2018 addr->transport_return = PANIC;
2019 goto PASS_BACK;
2020 }
2021
2022 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2023 when the process becomes unprivileged, it won't be able to write to the
2024 process log. SIGHUP is ignored throughout exim, except when it is being
2025 run as a daemon. */
2026
2027 signal(SIGINT, SIG_IGN);
2028 signal(SIGTERM, SIG_IGN);
2029 signal(SIGUSR1, SIG_IGN);
2030
2031 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2032 half - for transports that exec things (e.g. pipe). Then set the required
2033 gid/uid. */
2034
2035 (void)close(pfd[pipe_read]);
2036 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2037 FD_CLOEXEC);
2038 exim_setugid(uid, gid, use_initgroups,
2039 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2040 addr->address, addr->transport->name));
2041
2042 DEBUG(D_deliver)
2043 {
2044 address_item *batched;
2045 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2046 for (batched = addr->next; batched; batched = batched->next)
2047 debug_printf("additional batched address: %s\n", batched->address);
2048 }
2049
2050 /* Set an appropriate working directory. */
2051
2052 if (Uchdir(working_directory) < 0)
2053 {
2054 addr->transport_return = DEFER;
2055 addr->basic_errno = errno;
2056 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2057 }
2058
2059 /* If successful, call the transport */
2060
2061 else
2062 {
2063 BOOL ok = TRUE;
2064 set_process_info("delivering %s to %s using %s", message_id,
2065 addr->local_part, addr->transport->name);
2066
2067 /* Setting this global in the subprocess means we need never clear it */
2068 transport_name = addr->transport->name;
2069
2070 /* If a transport filter has been specified, set up its argument list.
2071 Any errors will get put into the address, and FALSE yielded. */
2072
2073 if (addr->transport->filter_command)
2074 {
2075 ok = transport_set_up_command(&transport_filter_argv,
2076 addr->transport->filter_command,
2077 TRUE, PANIC, addr, US"transport filter", NULL);
2078 transport_filter_timeout = addr->transport->filter_timeout;
2079 }
2080 else transport_filter_argv = NULL;
2081
2082 if (ok)
2083 {
2084 debug_print_string(addr->transport->debug_string);
2085 replicate = !(addr->transport->info->code)(addr->transport, addr);
2086 }
2087 }
2088
2089 /* Pass the results back down the pipe. If necessary, first replicate the
2090 status in the top address to the others in the batch. The label is the
2091 subject of a goto when a call to the transport's setup function fails. We
2092 pass the pointer to the transport back in case it got changed as a result of
2093 file_format in appendfile. */
2094
2095 PASS_BACK:
2096
2097 if (replicate) replicate_status(addr);
2098 for (addr2 = addr; addr2; addr2 = addr2->next)
2099 {
2100 int i;
2101 int local_part_length = Ustrlen(addr2->local_part);
2102 uschar *s;
2103 int ret;
2104
2105 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2106 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2107 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2108 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2109 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2110 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2111 || (ret = write(pfd[pipe_write], &addr2->transport,
2112 sizeof(transport_instance *))) != sizeof(transport_instance *)
2113
2114 /* For a file delivery, pass back the local part, in case the original
2115 was only part of the final delivery path. This gives more complete
2116 logging. */
2117
2118 || (testflag(addr2, af_file)
2119 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2120 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2121 )
2122 )
2123 )
2124 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2125 ret == -1 ? strerror(errno) : "short write");
2126
2127 /* Now any messages */
2128
2129 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2130 {
2131 int message_length = s ? Ustrlen(s) + 1 : 0;
2132 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2133 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2134 )
2135 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2136 ret == -1 ? strerror(errno) : "short write");
2137 }
2138 }
2139
2140 /* OK, this process is now done. Free any cached resources that it opened,
2141 and close the pipe we were writing down before exiting. */
2142
2143 (void)close(pfd[pipe_write]);
2144 search_tidyup();
2145 exit(EXIT_SUCCESS);
2146 }
2147
2148/* Back in the main process: panic if the fork did not succeed. This seems
2149better than returning an error - if forking is failing it is probably best
2150not to try other deliveries for this message. */
2151
2152if (pid < 0)
2153 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2154 addr->address);
2155
2156/* Read the pipe to get the delivery status codes and error messages. Our copy
2157of the writing end must be closed first, as otherwise read() won't return zero
2158on an empty pipe. We check that a status exists for each address before
2159overwriting the address structure. If data is missing, the default DEFER status
2160will remain. Afterwards, close the reading end. */
2161
2162(void)close(pfd[pipe_write]);
2163
2164for (addr2 = addr; addr2; addr2 = addr2->next)
2165 {
2166 len = read(pfd[pipe_read], &status, sizeof(int));
2167 if (len > 0)
2168 {
2169 int i;
2170 uschar **sptr;
2171
2172 addr2->transport_return = status;
2173 len = read(pfd[pipe_read], &transport_count,
2174 sizeof(transport_count));
2175 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2176 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2177 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2178 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2179 len = read(pfd[pipe_read], &addr2->transport,
2180 sizeof(transport_instance *));
2181
2182 if (testflag(addr2, af_file))
2183 {
2184 int local_part_length;
2185 len = read(pfd[pipe_read], &local_part_length, sizeof(int));
2186 len = read(pfd[pipe_read], big_buffer, local_part_length);
2187 big_buffer[local_part_length] = 0;
2188 addr2->local_part = string_copy(big_buffer);
2189 }
2190
2191 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2192 {
2193 int message_length;
2194 len = read(pfd[pipe_read], &message_length, sizeof(int));
2195 if (message_length > 0)
2196 {
2197 len = read(pfd[pipe_read], big_buffer, message_length);
2198 if (len > 0) *sptr = string_copy(big_buffer);
2199 }
2200 }
2201 }
2202
2203 else
2204 {
2205 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2206 "from delivery subprocess", addr2->unique);
2207 break;
2208 }
2209 }
2210
2211(void)close(pfd[pipe_read]);
2212
2213/* Unless shadowing, write all successful addresses immediately to the journal
2214file, to ensure they are recorded asap. For homonymic addresses, use the base
2215address plus the transport name. Failure to write the journal is panic-worthy,
2216but don't stop, as it may prove possible subsequently to update the spool file
2217in order to record the delivery. */
2218
2219if (!shadowing)
2220 {
2221 for (addr2 = addr; addr2; addr2 = addr2->next)
2222 if (addr2->transport_return == OK)
2223 {
2224 if (testflag(addr2, af_homonym))
2225 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2226 else
2227 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2228
2229 /* In the test harness, wait just a bit to let the subprocess finish off
2230 any debug output etc first. */
2231
2232 if (running_in_test_harness) millisleep(300);
2233
2234 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2235 len = Ustrlen(big_buffer);
2236 if (write(journal_fd, big_buffer, len) != len)
2237 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2238 big_buffer, strerror(errno));
2239 }
2240
2241 /* Ensure the journal file is pushed out to disk. */
2242
2243 if (EXIMfsync(journal_fd) < 0)
2244 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2245 strerror(errno));
2246 }
2247
2248/* Wait for the process to finish. If it terminates with a non-zero code,
2249freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2250status values of all the addresses as they are. Take care to handle the case
2251when the subprocess doesn't seem to exist. This has been seen on one system
2252when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2253happens, wait() doesn't recognize the termination of child processes. Exim now
2254resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2255
2256while ((rc = wait(&status)) != pid)
2257 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2258 {
2259 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2260 addr->transport->driver_name);
2261 status = 0;
2262 break;
2263 }
2264
2265if ((status & 0xffff) != 0)
2266 {
2267 int msb = (status >> 8) & 255;
2268 int lsb = status & 255;
2269 int code = (msb == 0)? (lsb & 0x7f) : msb;
2270 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2271 addr->special_action = SPECIAL_FREEZE;
2272 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2273 "status 0x%04x: %s %d",
2274 addr->transport->driver_name,
2275 status,
2276 msb == 0 ? "terminated by signal" : "exit code",
2277 code);
2278 }
2279
2280/* If SPECIAL_WARN is set in the top address, send a warning message. */
2281
2282if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2283 {
2284 int fd;
2285 uschar *warn_message;
2286 pid_t pid;
2287
2288 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2289
2290 if (!(warn_message = expand_string(addr->transport->warn_message)))
2291 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2292 "message for %s transport): %s", addr->transport->warn_message,
2293 addr->transport->name, expand_string_message);
2294
2295 else if ((pid = child_open_exim(&fd)) > 0)
2296 {
2297 FILE *f = fdopen(fd, "wb");
2298 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2299 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2300 fprintf(f, "Auto-Submitted: auto-replied\n");
2301 if (!contains_header(US"From", warn_message))
2302 moan_write_from(f);
2303 fprintf(f, "%s", CS warn_message);
2304
2305 /* Close and wait for child process to complete, without a timeout. */
2306
2307 (void)fclose(f);
2308 (void)child_close(pid, 0);
2309 }
2310
2311 addr->special_action = SPECIAL_NONE;
2312 }
2313}
2314
2315
2316
2317
2318/* Put the chain of addrs on the defer list. Retry will happen
2319on the next queue run, earlier if triggered by a new message.
2320Loop for the next set of addresses. */
2321
2322static void
2323deferlist_chain(address_item * addr)
2324{
2325address_item * next;
2326for (next = addr; next->next; next = next->next) ;
2327next->next = addr_defer;
2328addr_defer = addr;
2329}
2330
2331
2332
2333/*************************************************
2334* Do local deliveries *
2335*************************************************/
2336
2337/* This function processes the list of addresses in addr_local. True local
2338deliveries are always done one address at a time. However, local deliveries can
2339be batched up in some cases. Typically this is when writing batched SMTP output
2340files for use by some external transport mechanism, or when running local
2341deliveries over LMTP.
2342
2343Arguments: None
2344Returns: Nothing
2345*/
2346
2347static void
2348do_local_deliveries(void)
2349{
2350open_db dbblock;
2351open_db *dbm_file = NULL;
2352time_t now = time(NULL);
2353
2354/* Loop until we have exhausted the supply of local deliveries */
2355
2356while (addr_local)
2357 {
2358 time_t delivery_start;
2359 int deliver_time;
2360 address_item *addr2, *addr3, *nextaddr;
2361 int logflags = LOG_MAIN;
2362 int logchar = dont_deliver? '*' : '=';
2363 transport_instance *tp;
2364 uschar * serialize_key = NULL;
2365
2366 /* Pick the first undelivered address off the chain */
2367
2368 address_item *addr = addr_local;
2369 addr_local = addr->next;
2370 addr->next = NULL;
2371
2372 DEBUG(D_deliver|D_transport)
2373 debug_printf("--------> %s <--------\n", addr->address);
2374
2375 /* An internal disaster if there is no transport. Should not occur! */
2376
2377 if (!(tp = addr->transport))
2378 {
2379 logflags |= LOG_PANIC;
2380 disable_logging = FALSE; /* Jic */
2381 addr->message = addr->router
2382 ? string_sprintf("No transport set by %s router", addr->router->name)
2383 : string_sprintf("No transport set by system filter");
2384 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2385 continue;
2386 }
2387
2388 /* Check that this base address hasn't previously been delivered to this
2389 transport. The check is necessary at this point to handle homonymic addresses
2390 correctly in cases where the pattern of redirection changes between delivery
2391 attempts. Non-homonymic previous delivery is detected earlier, at routing
2392 time. */
2393
2394 if (previously_transported(addr, FALSE)) continue;
2395
2396 /* There are weird cases where logging is disabled */
2397
2398 disable_logging = tp->disable_logging;
2399
2400 /* Check for batched addresses and possible amalgamation. Skip all the work
2401 if either batch_max <= 1 or there aren't any other addresses for local
2402 delivery. */
2403
2404 if (tp->batch_max > 1 && addr_local)
2405 {
2406 int batch_count = 1;
2407 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2408 BOOL uses_lp = ( testflag(addr, af_pfr)
2409 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2410 )
2411 || readconf_depends((driver_instance *)tp, US"local_part");
2412 uschar *batch_id = NULL;
2413 address_item **anchor = &addr_local;
2414 address_item *last = addr;
2415 address_item *next;
2416
2417 /* Expand the batch_id string for comparison with other addresses.
2418 Expansion failure suppresses batching. */
2419
2420 if (tp->batch_id)
2421 {
2422 deliver_set_expansions(addr);
2423 batch_id = expand_string(tp->batch_id);
2424 deliver_set_expansions(NULL);
2425 if (!batch_id)
2426 {
2427 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2428 "in %s transport (%s): %s", tp->name, addr->address,
2429 expand_string_message);
2430 batch_count = tp->batch_max;
2431 }
2432 }
2433
2434 /* Until we reach the batch_max limit, pick off addresses which have the
2435 same characteristics. These are:
2436
2437 same transport
2438 not previously delivered (see comment about 50 lines above)
2439 same local part if the transport's configuration contains $local_part
2440 or if this is a file or pipe delivery from a redirection
2441 same domain if the transport's configuration contains $domain
2442 same errors address
2443 same additional headers
2444 same headers to be removed
2445 same uid/gid for running the transport
2446 same first host if a host list is set
2447 */
2448
2449 while ((next = *anchor) && batch_count < tp->batch_max)
2450 {
2451 BOOL ok =
2452 tp == next->transport
2453 && !previously_transported(next, TRUE)
2454 && (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file))
2455 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2456 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2457 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2458 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2459 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2460 && same_ugid(tp, addr, next)
2461 && ( !addr->host_list && !next->host_list
2462 || addr->host_list
2463 && next->host_list
2464 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2465 );
2466
2467 /* If the transport has a batch_id setting, batch_id will be non-NULL
2468 from the expansion outside the loop. Expand for this address and compare.
2469 Expansion failure makes this address ineligible for batching. */
2470
2471 if (ok && batch_id)
2472 {
2473 uschar *bid;
2474 address_item *save_nextnext = next->next;
2475 next->next = NULL; /* Expansion for a single address */
2476 deliver_set_expansions(next);
2477 next->next = save_nextnext;
2478 bid = expand_string(tp->batch_id);
2479 deliver_set_expansions(NULL);
2480 if (!bid)
2481 {
2482 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2483 "in %s transport (%s): %s", tp->name, next->address,
2484 expand_string_message);
2485 ok = FALSE;
2486 }
2487 else ok = (Ustrcmp(batch_id, bid) == 0);
2488 }
2489
2490 /* Take address into batch if OK. */
2491
2492 if (ok)
2493 {
2494 *anchor = next->next; /* Include the address */
2495 next->next = NULL;
2496 last->next = next;
2497 last = next;
2498 batch_count++;
2499 }
2500 else anchor = &next->next; /* Skip the address */
2501 }
2502 }
2503
2504 /* We now have one or more addresses that can be delivered in a batch. Check
2505 whether the transport is prepared to accept a message of this size. If not,
2506 fail them all forthwith. If the expansion fails, or does not yield an
2507 integer, defer delivery. */
2508
2509 if (tp->message_size_limit)
2510 {
2511 int rc = check_message_size(tp, addr);
2512 if (rc != OK)
2513 {
2514 replicate_status(addr);
2515 while (addr)
2516 {
2517 addr2 = addr->next;
2518 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2519 addr = addr2;
2520 }
2521 continue; /* With next batch of addresses */
2522 }
2523 }
2524
2525 /* If we are not running the queue, or if forcing, all deliveries will be
2526 attempted. Otherwise, we must respect the retry times for each address. Even
2527 when not doing this, we need to set up the retry key string, and determine
2528 whether a retry record exists, because after a successful delivery, a delete
2529 retry item must be set up. Keep the retry database open only for the duration
2530 of these checks, rather than for all local deliveries, because some local
2531 deliveries (e.g. to pipes) can take a substantial time. */
2532
2533 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2534 {
2535 DEBUG(D_deliver|D_retry|D_hints_lookup)
2536 debug_printf("no retry data available\n");
2537 }
2538
2539 addr2 = addr;
2540 addr3 = NULL;
2541 while (addr2)
2542 {
2543 BOOL ok = TRUE; /* to deliver this address */
2544 uschar *retry_key;
2545
2546 /* Set up the retry key to include the domain or not, and change its
2547 leading character from "R" to "T". Must make a copy before doing this,
2548 because the old key may be pointed to from a "delete" retry item after
2549 a routing delay. */
2550
2551 retry_key = string_copy(
2552 tp->retry_use_local_part ? addr2->address_retry_key :
2553 addr2->domain_retry_key);
2554 *retry_key = 'T';
2555
2556 /* Inspect the retry data. If there is no hints file, delivery happens. */
2557
2558 if (dbm_file)
2559 {
2560 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2561
2562 /* If there is no retry record, delivery happens. If there is,
2563 remember it exists so it can be deleted after a successful delivery. */
2564
2565 if (retry_record)
2566 {
2567 setflag(addr2, af_lt_retry_exists);
2568
2569 /* A retry record exists for this address. If queue running and not
2570 forcing, inspect its contents. If the record is too old, or if its
2571 retry time has come, or if it has passed its cutoff time, delivery
2572 will go ahead. */
2573
2574 DEBUG(D_retry)
2575 {
2576 debug_printf("retry record exists: age=%s ",
2577 readconf_printtime(now - retry_record->time_stamp));
2578 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2579 debug_printf(" time to retry = %s expired = %d\n",
2580 readconf_printtime(retry_record->next_try - now),
2581 retry_record->expired);
2582 }
2583
2584 if (queue_running && !deliver_force)
2585 {
2586 ok = (now - retry_record->time_stamp > retry_data_expire)
2587 || (now >= retry_record->next_try)
2588 || retry_record->expired;
2589
2590 /* If we haven't reached the retry time, there is one more check
2591 to do, which is for the ultimate address timeout. */
2592
2593 if (!ok)
2594 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2595 retry_record, now);
2596 }
2597 }
2598 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2599 }
2600
2601 /* This address is to be delivered. Leave it on the chain. */
2602
2603 if (ok)
2604 {
2605 addr3 = addr2;
2606 addr2 = addr2->next;
2607 }
2608
2609 /* This address is to be deferred. Take it out of the chain, and
2610 post-process it as complete. Must take it out of the chain first,
2611 because post processing puts it on another chain. */
2612
2613 else
2614 {
2615 address_item *this = addr2;
2616 this->message = US"Retry time not yet reached";
2617 this->basic_errno = ERRNO_LRETRY;
2618 addr2 = addr3 ? (addr3->next = addr2->next)
2619 : (addr = addr2->next);
2620 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2621 }
2622 }
2623
2624 if (dbm_file) dbfn_close(dbm_file);
2625
2626 /* If there are no addresses left on the chain, they all deferred. Loop
2627 for the next set of addresses. */
2628
2629 if (!addr) continue;
2630
2631 /* If the transport is limited for parallellism, enforce that here.
2632 We use a hints DB entry, incremented here and decremented after
2633 the transport (and any shadow transport) completes. */
2634
2635 if (tp->max_parallel)
2636 {
2637 int_eximarith_t max_parallel =
2638 expand_string_integer(tp->max_parallel, TRUE);
2639 if (expand_string_message)
2640 {
2641 logflags |= LOG_PANIC;
2642 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2643 "in %s transport (%s): %s", tp->name, addr->address,
2644 expand_string_message);
2645 for (addr2 = addr->next; addr; addr = addr2, addr2 = addr2->next)
2646 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2647 continue;
2648 }
2649 if ( max_parallel > 0
2650 && !enq_start(
2651 serialize_key = string_sprintf("tpt-serialize-%s", tp->name),
2652 (unsigned) max_parallel)
2653 )
2654 {
2655 DEBUG(D_transport)
2656 debug_printf("skipping tpt %s because parallelism limit %u reached\n",
2657 tp->name, (unsigned) max_parallel);
2658
2659 deferlist_chain(addr);
2660 continue;
2661 }
2662 }
2663
2664
2665 /* So, finally, we do have some addresses that can be passed to the
2666 transport. Before doing so, set up variables that are relevant to a
2667 single delivery. */
2668
2669 deliver_set_expansions(addr);
2670 delivery_start = time(NULL);
2671 deliver_local(addr, FALSE);
2672 deliver_time = (int)(time(NULL) - delivery_start);
2673
2674 /* If a shadow transport (which must perforce be another local transport), is
2675 defined, and its condition is met, we must pass the message to the shadow
2676 too, but only those addresses that succeeded. We do this by making a new
2677 chain of addresses - also to keep the original chain uncontaminated. We must
2678 use a chain rather than doing it one by one, because the shadow transport may
2679 batch.
2680
2681 NOTE: if the condition fails because of a lookup defer, there is nothing we
2682 can do! */
2683
2684 if ( tp->shadow
2685 && ( !tp->shadow_condition
2686 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
2687 ) )
2688 {
2689 transport_instance *stp;
2690 address_item *shadow_addr = NULL;
2691 address_item **last = &shadow_addr;
2692
2693 for (stp = transports; stp; stp = stp->next)
2694 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2695
2696 if (!stp)
2697 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2698 tp->shadow);
2699
2700 /* Pick off the addresses that have succeeded, and make clones. Put into
2701 the shadow_message field a pointer to the shadow_message field of the real
2702 address. */
2703
2704 else for (addr2 = addr; addr2; addr2 = addr2->next)
2705 if (addr2->transport_return == OK)
2706 {
2707 addr3 = store_get(sizeof(address_item));
2708 *addr3 = *addr2;
2709 addr3->next = NULL;
2710 addr3->shadow_message = (uschar *) &(addr2->shadow_message);
2711 addr3->transport = stp;
2712 addr3->transport_return = DEFER;
2713 addr3->return_filename = NULL;
2714 addr3->return_file = -1;
2715 *last = addr3;
2716 last = &(addr3->next);
2717 }
2718
2719 /* If we found any addresses to shadow, run the delivery, and stick any
2720 message back into the shadow_message field in the original. */
2721
2722 if (shadow_addr)
2723 {
2724 int save_count = transport_count;
2725
2726 DEBUG(D_deliver|D_transport)
2727 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2728 deliver_local(shadow_addr, TRUE);
2729
2730 for(; shadow_addr; shadow_addr = shadow_addr->next)
2731 {
2732 int sresult = shadow_addr->transport_return;
2733 *(uschar **)shadow_addr->shadow_message =
2734 sresult == OK
2735 ? string_sprintf(" ST=%s", stp->name)
2736 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
2737 shadow_addr->basic_errno <= 0
2738 ? US""
2739 : US strerror(shadow_addr->basic_errno),
2740 shadow_addr->basic_errno <= 0 || !shadow_addr->message
2741 ? US""
2742 : US": ",
2743 shadow_addr->message
2744 ? shadow_addr->message
2745 : shadow_addr->basic_errno <= 0
2746 ? US"unknown error"
2747 : US"");
2748
2749 DEBUG(D_deliver|D_transport)
2750 debug_printf("%s shadow transport returned %s for %s\n",
2751 stp->name,
2752 sresult == OK ? "OK" :
2753 sresult == DEFER ? "DEFER" :
2754 sresult == FAIL ? "FAIL" :
2755 sresult == PANIC ? "PANIC" : "?",
2756 shadow_addr->address);
2757 }
2758
2759 DEBUG(D_deliver|D_transport)
2760 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2761
2762 transport_count = save_count; /* Restore original transport count */
2763 }
2764 }
2765
2766 /* Cancel the expansions that were set up for the delivery. */
2767
2768 deliver_set_expansions(NULL);
2769
2770 /* If the transport was parallelism-limited, decrement the hints DB record. */
2771
2772 if (serialize_key) enq_end(serialize_key);
2773
2774 /* Now we can process the results of the real transport. We must take each
2775 address off the chain first, because post_process_one() puts it on another
2776 chain. */
2777
2778 for (addr2 = addr; addr2; addr2 = nextaddr)
2779 {
2780 int result = addr2->transport_return;
2781 nextaddr = addr2->next;
2782
2783 DEBUG(D_deliver|D_transport)
2784 debug_printf("%s transport returned %s for %s\n",
2785 tp->name,
2786 result == OK ? "OK" :
2787 result == DEFER ? "DEFER" :
2788 result == FAIL ? "FAIL" :
2789 result == PANIC ? "PANIC" : "?",
2790 addr2->address);
2791
2792 /* If there is a retry_record, or if delivery is deferred, build a retry
2793 item for setting a new retry time or deleting the old retry record from
2794 the database. These items are handled all together after all addresses
2795 have been handled (so the database is open just for a short time for
2796 updating). */
2797
2798 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2799 {
2800 int flags = result == DEFER ? 0 : rf_delete;
2801 uschar *retry_key = string_copy(tp->retry_use_local_part
2802 ? addr2->address_retry_key : addr2->domain_retry_key);
2803 *retry_key = 'T';
2804 retry_add_item(addr2, retry_key, flags);
2805 }
2806
2807 /* Done with this address */
2808
2809 if (result == OK) addr2->more_errno = deliver_time;
2810 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2811
2812 /* If a pipe delivery generated text to be sent back, the result may be
2813 changed to FAIL, and we must copy this for subsequent addresses in the
2814 batch. */
2815
2816 if (addr2->transport_return != result)
2817 {
2818 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
2819 {
2820 addr3->transport_return = addr2->transport_return;
2821 addr3->basic_errno = addr2->basic_errno;
2822 addr3->message = addr2->message;
2823 }
2824 result = addr2->transport_return;
2825 }
2826
2827 /* Whether or not the result was changed to FAIL, we need to copy the
2828 return_file value from the first address into all the addresses of the
2829 batch, so they are all listed in the error message. */
2830
2831 addr2->return_file = addr->return_file;
2832
2833 /* Change log character for recording successful deliveries. */
2834
2835 if (result == OK) logchar = '-';
2836 }
2837 } /* Loop back for next batch of addresses */
2838}
2839
2840
2841
2842
2843/*************************************************
2844* Sort remote deliveries *
2845*************************************************/
2846
2847/* This function is called if remote_sort_domains is set. It arranges that the
2848chain of addresses for remote deliveries is ordered according to the strings
2849specified. Try to make this shuffling reasonably efficient by handling
2850sequences of addresses rather than just single ones.
2851
2852Arguments: None
2853Returns: Nothing
2854*/
2855
2856static void
2857sort_remote_deliveries(void)
2858{
2859int sep = 0;
2860address_item **aptr = &addr_remote;
2861const uschar *listptr = remote_sort_domains;
2862uschar *pattern;
2863uschar patbuf[256];
2864
2865while ( *aptr
2866 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2867 )
2868 {
2869 address_item *moved = NULL;
2870 address_item **bptr = &moved;
2871
2872 while (*aptr)
2873 {
2874 address_item **next;
2875 deliver_domain = (*aptr)->domain; /* set $domain */
2876 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2877 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2878 {
2879 aptr = &(*aptr)->next;
2880 continue;
2881 }
2882
2883 next = &(*aptr)->next;
2884 while ( *next
2885 && (deliver_domain = (*next)->domain, /* Set $domain */
2886 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2887 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
2888 )
2889 next = &(*next)->next;
2890
2891 /* If the batch of non-matchers is at the end, add on any that were
2892 extracted further up the chain, and end this iteration. Otherwise,
2893 extract them from the chain and hang on the moved chain. */
2894
2895 if (!*next)
2896 {
2897 *next = moved;
2898 break;
2899 }
2900
2901 *bptr = *aptr;
2902 *aptr = *next;
2903 *next = NULL;
2904 bptr = next;
2905 aptr = &(*aptr)->next;
2906 }
2907
2908 /* If the loop ended because the final address matched, *aptr will
2909 be NULL. Add on to the end any extracted non-matching addresses. If
2910 *aptr is not NULL, the loop ended via "break" when *next is null, that
2911 is, there was a string of non-matching addresses at the end. In this
2912 case the extracted addresses have already been added on the end. */
2913
2914 if (!*aptr) *aptr = moved;
2915 }
2916
2917DEBUG(D_deliver)
2918 {
2919 address_item *addr;
2920 debug_printf("remote addresses after sorting:\n");
2921 for (addr = addr_remote; addr; addr = addr->next)
2922 debug_printf(" %s\n", addr->address);
2923 }
2924}
2925
2926
2927
2928/*************************************************
2929* Read from pipe for remote delivery subprocess *
2930*************************************************/
2931
2932/* This function is called when the subprocess is complete, but can also be
2933called before it is complete, in order to empty a pipe that is full (to prevent
2934deadlock). It must therefore keep track of its progress in the parlist data
2935block.
2936
2937We read the pipe to get the delivery status codes and a possible error message
2938for each address, optionally preceded by unusability data for the hosts and
2939also by optional retry data.
2940
2941Read in large chunks into the big buffer and then scan through, interpreting
2942the data therein. In most cases, only a single read will be necessary. No
2943individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2944that we read the next chunk when there is less than 2500 bytes left in the
2945non-final chunk, we can assume each item is complete in the buffer before
2946handling it. Each item is written using a single write(), which is atomic for
2947small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2948often bigger) so even if we are reading while the subprocess is still going, we
2949should never have only a partial item in the buffer.
2950
2951Argument:
2952 poffset the offset of the parlist item
2953 eop TRUE if the process has completed
2954
2955Returns: TRUE if the terminating 'Z' item has been read,
2956 or there has been a disaster (i.e. no more data needed);
2957 FALSE otherwise
2958*/
2959
2960static BOOL
2961par_read_pipe(int poffset, BOOL eop)
2962{
2963host_item *h;
2964pardata *p = parlist + poffset;
2965address_item *addrlist = p->addrlist;
2966address_item *addr = p->addr;
2967pid_t pid = p->pid;
2968int fd = p->fd;
2969uschar *endptr = big_buffer;
2970uschar *ptr = endptr;
2971uschar *msg = p->msg;
2972BOOL done = p->done;
2973BOOL unfinished = TRUE;
2974/* minimum size to read is header size including id, subid and length */
2975int required = PIPE_HEADER_SIZE;
2976
2977/* Loop through all items, reading from the pipe when necessary. The pipe
2978is set up to be non-blocking, but there are two different Unix mechanisms in
2979use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2980and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2981which returns 0 for both end of file and no more data. We distinguish the
2982two cases by taking 0 as end of file only when we know the process has
2983completed.
2984
2985Each separate item is written to the pipe in a single write(), and as they are
2986all short items, the writes will all be atomic and we should never find
2987ourselves in the position of having read an incomplete item. "Short" in this
2988case can mean up to about 1K in the case when there is a long error message
2989associated with an address. */
2990
2991DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2992 (int)p->pid, eop? "ended" : "not ended");
2993
2994while (!done)
2995 {
2996 retry_item *r, **rp;
2997 int remaining = endptr - ptr;
2998 uschar header[PIPE_HEADER_SIZE + 1];
2999 uschar id, subid;
3000 uschar *endc;
3001
3002 /* Read (first time) or top up the chars in the buffer if necessary.
3003 There will be only one read if we get all the available data (i.e. don't
3004 fill the buffer completely). */
3005
3006 if (remaining < required && unfinished)
3007 {
3008 int len;
3009 int available = big_buffer_size - remaining;
3010
3011 if (remaining > 0) memmove(big_buffer, ptr, remaining);
3012
3013 ptr = big_buffer;
3014 endptr = big_buffer + remaining;
3015 len = read(fd, endptr, available);
3016
3017 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
3018
3019 /* If the result is EAGAIN and the process is not complete, just
3020 stop reading any more and process what we have already. */
3021
3022 if (len < 0)
3023 {
3024 if (!eop && errno == EAGAIN) len = 0; else
3025 {
3026 msg = string_sprintf("failed to read pipe from transport process "
3027 "%d for transport %s: %s", pid, addr->transport->driver_name,
3028 strerror(errno));
3029 break;
3030 }
3031 }
3032
3033 /* If the length is zero (eof or no-more-data), just process what we
3034 already have. Note that if the process is still running and we have
3035 read all the data in the pipe (but less that "available") then we
3036 won't read any more, as "unfinished" will get set FALSE. */
3037
3038 endptr += len;
3039 remaining += len;
3040 unfinished = len == available;
3041 }
3042
3043 /* If we are at the end of the available data, exit the loop. */
3044 if (ptr >= endptr) break;
3045
3046 /* copy and read header */
3047 memcpy(header, ptr, PIPE_HEADER_SIZE);
3048 header[PIPE_HEADER_SIZE] = '\0';
3049 id = header[0];
3050 subid = header[1];
3051 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
3052 if (*endc)
3053 {
3054 msg = string_sprintf("failed to read pipe from transport process "
3055 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
3056 done = TRUE;
3057 break;
3058 }
3059
3060 DEBUG(D_deliver)
3061 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
3062 id, subid, header+2, required, remaining, unfinished);
3063
3064 /* is there room for the dataset we want to read ? */
3065 if (required > big_buffer_size - PIPE_HEADER_SIZE)
3066 {
3067 msg = string_sprintf("failed to read pipe from transport process "
3068 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
3069 required, big_buffer_size - PIPE_HEADER_SIZE);
3070 done = TRUE;
3071 break;
3072 }
3073
3074 /* we wrote all datasets with atomic write() calls
3075 remaining < required only happens if big_buffer was too small
3076 to get all available data from pipe. unfinished has to be true
3077 as well. */
3078 if (remaining < required)
3079 {
3080 if (unfinished)
3081 continue;
3082 msg = string_sprintf("failed to read pipe from transport process "
3083 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3084 pid, addr->transport->driver_name, required, remaining);
3085 done = TRUE;
3086 break;
3087 }
3088
3089 /* step behind the header */
3090 ptr += PIPE_HEADER_SIZE;
3091
3092 /* Handle each possible type of item, assuming the complete item is
3093 available in store. */
3094
3095 switch (id)
3096 {
3097 /* Host items exist only if any hosts were marked unusable. Match
3098 up by checking the IP address. */
3099
3100 case 'H':
3101 for (h = addrlist->host_list; h; h = h->next)
3102 {
3103 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3104 h->status = ptr[0];
3105 h->why = ptr[1];
3106 }
3107 ptr += 2;
3108 while (*ptr++);
3109 break;
3110
3111 /* Retry items are sent in a preceding R item for each address. This is
3112 kept separate to keep each message short enough to guarantee it won't
3113 be split in the pipe. Hopefully, in the majority of cases, there won't in
3114 fact be any retry items at all.
3115
3116 The complete set of retry items might include an item to delete a
3117 routing retry if there was a previous routing delay. However, routing
3118 retries are also used when a remote transport identifies an address error.
3119 In that case, there may also be an "add" item for the same key. Arrange
3120 that a "delete" item is dropped in favour of an "add" item. */
3121
3122 case 'R':
3123 if (!addr) goto ADDR_MISMATCH;
3124
3125 DEBUG(D_deliver|D_retry)
3126 debug_printf("reading retry information for %s from subprocess\n",
3127 ptr+1);
3128
3129 /* Cut out any "delete" items on the list. */
3130
3131 for (rp = &(addr->retries); (r = *rp); rp = &r->next)
3132 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3133 {
3134 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3135 *rp = r->next; /* Excise a delete item */
3136 DEBUG(D_deliver|D_retry)
3137 debug_printf(" existing delete item dropped\n");
3138 }
3139
3140 /* We want to add a delete item only if there is no non-delete item;
3141 however we still have to step ptr through the data. */
3142
3143 if (!r || (*ptr & rf_delete) == 0)
3144 {
3145 r = store_get(sizeof(retry_item));
3146 r->next = addr->retries;
3147 addr->retries = r;
3148 r->flags = *ptr++;
3149 r->key = string_copy(ptr);
3150 while (*ptr++);
3151 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3152 ptr += sizeof(r->basic_errno);
3153 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3154 ptr += sizeof(r->more_errno);
3155 r->message = (*ptr)? string_copy(ptr) : NULL;
3156 DEBUG(D_deliver|D_retry)
3157 debug_printf(" added %s item\n",
3158 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3159 }
3160
3161 else
3162 {
3163 DEBUG(D_deliver|D_retry)
3164 debug_printf(" delete item not added: non-delete item exists\n");
3165 ptr++;
3166 while(*ptr++);
3167 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3168 }
3169
3170 while(*ptr++);
3171 break;
3172
3173 /* Put the amount of data written into the parlist block */
3174
3175 case 'S':
3176 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3177 ptr += sizeof(transport_count);
3178 break;
3179
3180 /* Address items are in the order of items on the address chain. We
3181 remember the current address value in case this function is called
3182 several times to empty the pipe in stages. Information about delivery
3183 over TLS is sent in a preceding X item for each address. We don't put
3184 it in with the other info, in order to keep each message short enough to
3185 guarantee it won't be split in the pipe. */
3186
3187#ifdef SUPPORT_TLS
3188 case 'X':
3189 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3190 switch (subid)
3191 {
3192 case '1':
3193 addr->cipher = NULL;
3194 addr->peerdn = NULL;
3195
3196 if (*ptr)
3197 addr->cipher = string_copy(ptr);
3198 while (*ptr++);
3199 if (*ptr)
3200 addr->peerdn = string_copy(ptr);
3201 break;
3202
3203 case '2':
3204 if (*ptr)
3205 (void) tls_import_cert(ptr, &addr->peercert);
3206 else
3207 addr->peercert = NULL;
3208 break;
3209
3210 case '3':
3211 if (*ptr)
3212 (void) tls_import_cert(ptr, &addr->ourcert);
3213 else
3214 addr->ourcert = NULL;
3215 break;
3216
3217# ifndef DISABLE_OCSP
3218 case '4':
3219 addr->ocsp = OCSP_NOT_REQ;
3220 if (*ptr)
3221 addr->ocsp = *ptr - '0';
3222 break;
3223# endif
3224 }
3225 while (*ptr++);
3226 break;
3227#endif /*SUPPORT_TLS*/
3228
3229 case 'C': /* client authenticator information */
3230 switch (subid)
3231 {
3232 case '1':
3233 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3234 break;
3235 case '2':
3236 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3237 break;
3238 case '3':
3239 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3240 break;
3241 }
3242 while (*ptr++);
3243 break;
3244
3245#ifndef DISABLE_PRDR
3246 case 'P':
3247 addr->flags |= af_prdr_used;
3248 break;
3249#endif
3250
3251 case 'D':
3252 if (!addr) goto ADDR_MISMATCH;
3253 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3254 ptr += sizeof(addr->dsn_aware);
3255 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3256 break;
3257
3258 case 'A':
3259 if (!addr)
3260 {
3261 ADDR_MISMATCH:
3262 msg = string_sprintf("address count mismatch for data read from pipe "
3263 "for transport process %d for transport %s", pid,
3264 addrlist->transport->driver_name);
3265 done = TRUE;
3266 break;
3267 }
3268
3269 switch (subid)
3270 {
3271#ifdef EXPERIMENTAL_DSN_INFO
3272 case '1': /* must arrive before A0, and applies to that addr */
3273 /* Two strings: smtp_greeting and helo_response */
3274 addr->smtp_greeting = string_copy(ptr);
3275 while(*ptr++);
3276 addr->helo_response = string_copy(ptr);
3277 while(*ptr++);
3278 break;
3279#endif
3280
3281 case '0':
3282 addr->transport_return = *ptr++;
3283 addr->special_action = *ptr++;
3284 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3285 ptr += sizeof(addr->basic_errno);
3286 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3287 ptr += sizeof(addr->more_errno);
3288 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3289 ptr += sizeof(addr->flags);
3290 addr->message = (*ptr)? string_copy(ptr) : NULL;
3291 while(*ptr++);
3292 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3293 while(*ptr++);
3294
3295 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3296
3297 if (*ptr != 0)
3298 {
3299 h = store_get(sizeof(host_item));
3300 h->name = string_copy(ptr);
3301 while (*ptr++);
3302 h->address = string_copy(ptr);
3303 while(*ptr++);
3304 memcpy(&(h->port), ptr, sizeof(h->port));
3305 ptr += sizeof(h->port);
3306 h->dnssec = *ptr == '2' ? DS_YES
3307 : *ptr == '1' ? DS_NO
3308 : DS_UNK;
3309 ptr++;
3310 addr->host_used = h;
3311 }
3312 else ptr++;
3313
3314 /* Finished with this address */
3315
3316 addr = addr->next;
3317 break;
3318 }
3319 break;
3320
3321 /* Local interface address/port */
3322 case 'I':
3323 if (*ptr) sending_ip_address = string_copy(ptr);
3324 while (*ptr++) ;
3325 if (*ptr) sending_port = atoi(CS ptr);
3326 while (*ptr++) ;
3327 break;
3328
3329 /* Z marks the logical end of the data. It is followed by '0' if
3330 continue_transport was NULL at the end of transporting, otherwise '1'.
3331 We need to know when it becomes NULL during a delivery down a passed SMTP
3332 channel so that we don't try to pass anything more down it. Of course, for
3333 most normal messages it will remain NULL all the time. */
3334
3335 case 'Z':
3336 if (*ptr == '0')
3337 {
3338 continue_transport = NULL;
3339 continue_hostname = NULL;
3340 }
3341 done = TRUE;
3342 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3343 break;
3344
3345 /* Anything else is a disaster. */
3346
3347 default:
3348 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3349 "process %d for transport %s", ptr[-1], pid,
3350 addr->transport->driver_name);
3351 done = TRUE;
3352 break;
3353 }
3354 }
3355
3356/* The done flag is inspected externally, to determine whether or not to
3357call the function again when the process finishes. */
3358
3359p->done = done;
3360
3361/* If the process hadn't finished, and we haven't seen the end of the data
3362or suffered a disaster, update the rest of the state, and return FALSE to
3363indicate "not finished". */
3364
3365if (!eop && !done)
3366 {
3367 p->addr = addr;
3368 p->msg = msg;
3369 return FALSE;
3370 }
3371
3372/* Close our end of the pipe, to prevent deadlock if the far end is still
3373pushing stuff into it. */
3374
3375(void)close(fd);
3376p->fd = -1;
3377
3378/* If we have finished without error, but haven't had data for every address,
3379something is wrong. */
3380
3381if (!msg && addr)
3382 msg = string_sprintf("insufficient address data read from pipe "
3383 "for transport process %d for transport %s", pid,
3384 addr->transport->driver_name);
3385
3386/* If an error message is set, something has gone wrong in getting back
3387the delivery data. Put the message into each address and freeze it. */
3388
3389if (msg)
3390 for (addr = addrlist; addr; addr = addr->next)
3391 {
3392 addr->transport_return = DEFER;
3393 addr->special_action = SPECIAL_FREEZE;
3394 addr->message = msg;
3395 }
3396
3397/* Return TRUE to indicate we have got all we need from this process, even
3398if it hasn't actually finished yet. */
3399
3400return TRUE;
3401}
3402
3403
3404
3405/*************************************************
3406* Post-process a set of remote addresses *
3407*************************************************/
3408
3409/* Do what has to be done immediately after a remote delivery for each set of
3410addresses, then re-write the spool if necessary. Note that post_process_one
3411puts the address on an appropriate queue; hence we must fish off the next
3412one first. This function is also called if there is a problem with setting
3413up a subprocess to do a remote delivery in parallel. In this case, the final
3414argument contains a message, and the action must be forced to DEFER.
3415
3416Argument:
3417 addr pointer to chain of address items
3418 logflags flags for logging
3419 msg NULL for normal cases; -> error message for unexpected problems
3420 fallback TRUE if processing fallback hosts
3421
3422Returns: nothing
3423*/
3424
3425static void
3426remote_post_process(address_item *addr, int logflags, uschar *msg,
3427 BOOL fallback)
3428{
3429host_item *h;
3430
3431/* If any host addresses were found to be unusable, add them to the unusable
3432tree so that subsequent deliveries don't try them. */
3433
3434for (h = addr->host_list; h; h = h->next)
3435 if (h->address)
3436 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3437
3438/* Now handle each address on the chain. The transport has placed '=' or '-'
3439into the special_action field for each successful delivery. */
3440
3441while (addr)
3442 {
3443 address_item *next = addr->next;
3444
3445 /* If msg == NULL (normal processing) and the result is DEFER and we are
3446 processing the main hosts and there are fallback hosts available, put the
3447 address on the list for fallback delivery. */
3448
3449 if ( addr->transport_return == DEFER
3450 && addr->fallback_hosts
3451 && !fallback
3452 && !msg
3453 )
3454 {
3455 addr->host_list = addr->fallback_hosts;
3456 addr->next = addr_fallback;
3457 addr_fallback = addr;
3458 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3459 }
3460
3461 /* If msg is set (=> unexpected problem), set it in the address before
3462 doing the ordinary post processing. */
3463
3464 else
3465 {
3466 if (msg)
3467 {
3468 addr->message = msg;
3469 addr->transport_return = DEFER;
3470 }
3471 (void)post_process_one(addr, addr->transport_return, logflags,
3472 DTYPE_TRANSPORT, addr->special_action);
3473 }
3474
3475 /* Next address */
3476
3477 addr = next;
3478 }
3479
3480/* If we have just delivered down a passed SMTP channel, and that was
3481the last address, the channel will have been closed down. Now that
3482we have logged that delivery, set continue_sequence to 1 so that
3483any subsequent deliveries don't get "*" incorrectly logged. */
3484
3485if (!continue_transport) continue_sequence = 1;
3486}
3487
3488
3489
3490/*************************************************
3491* Wait for one remote delivery subprocess *
3492*************************************************/
3493
3494/* This function is called while doing remote deliveries when either the
3495maximum number of processes exist and we need one to complete so that another
3496can be created, or when waiting for the last ones to complete. It must wait for
3497the completion of one subprocess, empty the control block slot, and return a
3498pointer to the address chain.
3499
3500Arguments: none
3501Returns: pointer to the chain of addresses handled by the process;
3502 NULL if no subprocess found - this is an unexpected error
3503*/
3504
3505static address_item *
3506par_wait(void)
3507{
3508int poffset, status;
3509address_item *addr, *addrlist;
3510pid_t pid;
3511
3512set_process_info("delivering %s: waiting for a remote delivery subprocess "
3513 "to finish", message_id);
3514
3515/* Loop until either a subprocess completes, or there are no subprocesses in
3516existence - in which case give an error return. We cannot proceed just by
3517waiting for a completion, because a subprocess may have filled up its pipe, and
3518be waiting for it to be emptied. Therefore, if no processes have finished, we
3519wait for one of the pipes to acquire some data by calling select(), with a
3520timeout just in case.
3521
3522The simple approach is just to iterate after reading data from a ready pipe.
3523This leads to non-ideal behaviour when the subprocess has written its final Z
3524item, closed the pipe, and is in the process of exiting (the common case). A
3525call to waitpid() yields nothing completed, but select() shows the pipe ready -
3526reading it yields EOF, so you end up with busy-waiting until the subprocess has
3527actually finished.
3528
3529To avoid this, if all the data that is needed has been read from a subprocess
3530after select(), an explicit wait() for it is done. We know that all it is doing
3531is writing to the pipe and then exiting, so the wait should not be long.
3532
3533The non-blocking waitpid() is to some extent just insurance; if we could
3534reliably detect end-of-file on the pipe, we could always know when to do a
3535blocking wait() for a completed process. However, because some systems use
3536NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3537use code that functions without the need to recognize EOF.
3538
3539There's a double loop here just in case we end up with a process that is not in
3540the list of remote delivery processes. Something has obviously gone wrong if
3541this is the case. (For example, a process that is incorrectly left over from
3542routing or local deliveries might be found.) The damage can be minimized by
3543looping back and looking for another process. If there aren't any, the error
3544return will happen. */
3545
3546for (;;) /* Normally we do not repeat this loop */
3547 {
3548 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3549 {
3550 struct timeval tv;
3551 fd_set select_pipes;
3552 int maxpipe, readycount;
3553
3554 /* A return value of -1 can mean several things. If errno != ECHILD, it
3555 either means invalid options (which we discount), or that this process was
3556 interrupted by a signal. Just loop to try the waitpid() again.
3557
3558 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3559 in existence. This should never happen, and is an unexpected error.
3560 However, there is a nasty complication when running under Linux. If "strace
3561 -f" is being used under Linux to trace this process and its children,
3562 subprocesses are "stolen" from their parents and become the children of the
3563 tracing process. A general wait such as the one we've just obeyed returns
3564 as if there are no children while subprocesses are running. Once a
3565 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3566 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3567 palliative.
3568
3569 This does not happen using "truss" on Solaris, nor (I think) with other
3570 tracing facilities on other OS. It seems to be specific to Linux.
3571
3572 What we do to get round this is to use kill() to see if any of our
3573 subprocesses are still in existence. If kill() gives an OK return, we know
3574 it must be for one of our processes - it can't be for a re-use of the pid,
3575 because if our process had finished, waitpid() would have found it. If any
3576 of our subprocesses are in existence, we proceed to use select() as if
3577 waitpid() had returned zero. I think this is safe. */
3578
3579 if (pid < 0)
3580 {
3581 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3582
3583 DEBUG(D_deliver)
3584 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3585 "for process existence\n");
3586
3587 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3588 {
3589 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3590 {
3591 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3592 "stolen by strace\n", (int)pid);
3593 break; /* With poffset set */
3594 }
3595 }
3596
3597 if (poffset >= remote_max_parallel)
3598 {
3599 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3600 return NULL; /* This is the error return */
3601 }
3602 }
3603
3604 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3605 been handled above. A return value of zero means that there is at least one
3606 subprocess, but there are no completed subprocesses. See if any pipes are
3607 ready with any data for reading. */
3608
3609 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3610
3611 maxpipe = 0;
3612 FD_ZERO(&select_pipes);
3613 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3614 {
3615 if (parlist[poffset].pid != 0)
3616 {
3617 int fd = parlist[poffset].fd;
3618 FD_SET(fd, &select_pipes);
3619 if (fd > maxpipe) maxpipe = fd;
3620 }
3621 }
3622
3623 /* Stick in a 60-second timeout, just in case. */
3624
3625 tv.tv_sec = 60;
3626 tv.tv_usec = 0;
3627
3628 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3629 NULL, NULL, &tv);
3630
3631 /* Scan through the pipes and read any that are ready; use the count
3632 returned by select() to stop when there are no more. Select() can return
3633 with no processes (e.g. if interrupted). This shouldn't matter.
3634
3635 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3636 read, or there was a disaster. In either case, we are finished with this
3637 process. Do an explicit wait() for the process and break the main loop if
3638 it succeeds.
3639
3640 It turns out that we have to deal with the case of an interrupted system
3641 call, which can happen on some operating systems if the signal handling is
3642 set up to do that by default. */
3643
3644 for (poffset = 0;
3645 readycount > 0 && poffset < remote_max_parallel;
3646 poffset++)
3647 {
3648 if ( (pid = parlist[poffset].pid) != 0
3649 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3650 )
3651 {
3652 readycount--;
3653 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3654 {
3655 for (;;) /* Loop for signals */
3656 {
3657 pid_t endedpid = waitpid(pid, &status, 0);
3658 if (endedpid == pid) goto PROCESS_DONE;
3659 if (endedpid != (pid_t)(-1) || errno != EINTR)
3660 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3661 "%d (errno = %d) from waitpid() for process %d",
3662 (int)endedpid, errno, (int)pid);
3663 }
3664 }
3665 }
3666 }
3667
3668 /* Now go back and look for a completed subprocess again. */
3669 }
3670
3671 /* A completed process was detected by the non-blocking waitpid(). Find the
3672 data block that corresponds to this subprocess. */
3673
3674 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3675 if (pid == parlist[poffset].pid) break;
3676
3677 /* Found the data block; this is a known remote delivery process. We don't
3678 need to repeat the outer loop. This should be what normally happens. */
3679
3680 if (poffset < remote_max_parallel) break;
3681
3682 /* This situation is an error, but it's probably better to carry on looking
3683 for another process than to give up (as we used to do). */
3684
3685 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3686 "transport process list", pid);
3687 } /* End of the "for" loop */
3688
3689/* Come here when all the data was completely read after a select(), and
3690the process in pid has been wait()ed for. */
3691
3692PROCESS_DONE:
3693
3694DEBUG(D_deliver)
3695 {
3696 if (status == 0)
3697 debug_printf("remote delivery process %d ended\n", (int)pid);
3698 else
3699 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3700 status);
3701 }
3702
3703set_process_info("delivering %s", message_id);
3704
3705/* Get the chain of processed addresses */
3706
3707addrlist = parlist[poffset].addrlist;
3708
3709/* If the process did not finish cleanly, record an error and freeze (except
3710for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3711in case the delivery did actually happen. */
3712
3713if ((status & 0xffff) != 0)
3714 {
3715 uschar *msg;
3716 int msb = (status >> 8) & 255;
3717 int lsb = status & 255;
3718 int code = (msb == 0)? (lsb & 0x7f) : msb;
3719
3720 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3721 "%s %d",
3722 addrlist->transport->driver_name,
3723 status,
3724 (msb == 0)? "terminated by signal" : "exit code",
3725 code);
3726
3727 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3728 addrlist->special_action = SPECIAL_FREEZE;
3729
3730 for (addr = addrlist; addr; addr = addr->next)
3731 {
3732 addr->transport_return = DEFER;
3733 addr->message = msg;
3734 }
3735
3736 remove_journal = FALSE;
3737 }
3738
3739/* Else complete reading the pipe to get the result of the delivery, if all
3740the data has not yet been obtained. */
3741
3742else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3743
3744/* Put the data count and return path into globals, mark the data slot unused,
3745decrement the count of subprocesses, and return the address chain. */
3746
3747transport_count = parlist[poffset].transport_count;
3748used_return_path = parlist[poffset].return_path;
3749parlist[poffset].pid = 0;
3750parcount--;
3751return addrlist;
3752}
3753
3754
3755
3756/*************************************************
3757* Wait for subprocesses and post-process *
3758*************************************************/
3759
3760/* This function waits for subprocesses until the number that are still running
3761is below a given threshold. For each complete subprocess, the addresses are
3762post-processed. If we can't find a running process, there is some shambles.
3763Better not bomb out, as that might lead to multiple copies of the message. Just
3764log and proceed as if all done.
3765
3766Arguments:
3767 max maximum number of subprocesses to leave running
3768 fallback TRUE if processing fallback hosts
3769
3770Returns: nothing
3771*/
3772
3773static void
3774par_reduce(int max, BOOL fallback)
3775{
3776while (parcount > max)
3777 {
3778 address_item *doneaddr = par_wait();
3779 if (!doneaddr)
3780 {
3781 log_write(0, LOG_MAIN|LOG_PANIC,
3782 "remote delivery process count got out of step");
3783 parcount = 0;
3784 }
3785 else
3786 {
3787 transport_instance * tp = doneaddr->transport;
3788 if (tp->max_parallel)
3789 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
3790
3791 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3792 }
3793 }
3794}
3795
3796
3797
3798
3799static void
3800rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
3801{
3802uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3803int header_length;
3804
3805/* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3806/* complain to log if someone tries with buffer sizes we can't handle*/
3807
3808if (size > 99999)
3809 {
3810 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3811 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3812 size = 99999;
3813 }
3814
3815/* to keep the write() atomic we build header in writebuffer and copy buf behind */
3816/* two write() calls would increase the complexity of reading from pipe */
3817
3818/* convert size to human readable string prepended by id and subid */
3819header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
3820if (header_length != PIPE_HEADER_SIZE)
3821 {
3822 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3823 writebuffer[0] = '\0';
3824 }
3825
3826DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3827 id, subid, size, writebuffer);
3828
3829if (buf && size > 0)
3830 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3831
3832size += PIPE_HEADER_SIZE;
3833int ret = write(fd, writebuffer, size);
3834if(ret != size)
3835 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3836 ret == -1 ? strerror(errno) : "short write");
3837}
3838
3839/*************************************************
3840* Do remote deliveries *
3841*************************************************/
3842
3843/* This function is called to process the addresses in addr_remote. We must
3844pick off the queue all addresses that have the same transport, remote
3845destination, and errors address, and hand them to the transport in one go,
3846subject to some configured limitations. If this is a run to continue delivering
3847to an existing delivery channel, skip all but those addresses that can go to
3848that channel. The skipped addresses just get deferred.
3849
3850If mua_wrapper is set, all addresses must be able to be sent in a single
3851transaction. If not, this function yields FALSE.
3852
3853In Exim 4, remote deliveries are always done in separate processes, even
3854if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3855is so that the base process can retain privilege. This makes the
3856implementation of fallback transports feasible (though not initially done.)
3857
3858We create up to the configured number of subprocesses, each of which passes
3859back the delivery state via a pipe. (However, when sending down an existing
3860connection, remote_max_parallel is forced to 1.)
3861
3862Arguments:
3863 fallback TRUE if processing fallback hosts
3864
3865Returns: TRUE normally
3866 FALSE if mua_wrapper is set and the addresses cannot all be sent
3867 in one transaction
3868*/
3869
3870static BOOL
3871do_remote_deliveries(BOOL fallback)
3872{
3873int parmax;
3874int delivery_count;
3875int poffset;
3876
3877parcount = 0; /* Number of executing subprocesses */
3878
3879/* When sending down an existing channel, only do one delivery at a time.
3880We use a local variable (parmax) to hold the maximum number of processes;
3881this gets reduced from remote_max_parallel if we can't create enough pipes. */
3882
3883if (continue_transport) remote_max_parallel = 1;
3884parmax = remote_max_parallel;
3885
3886/* If the data for keeping a list of processes hasn't yet been
3887set up, do so. */
3888
3889if (!parlist)
3890 {
3891 parlist = store_get(remote_max_parallel * sizeof(pardata));
3892 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3893 parlist[poffset].pid = 0;
3894 }
3895
3896/* Now loop for each remote delivery */
3897
3898for (delivery_count = 0; addr_remote; delivery_count++)
3899 {
3900 pid_t pid;
3901 uid_t uid;
3902 gid_t gid;
3903 int pfd[2];
3904 int address_count = 1;
3905 int address_count_max;
3906 BOOL multi_domain;
3907 BOOL use_initgroups;
3908 BOOL pipe_done = FALSE;
3909 transport_instance *tp;
3910 address_item **anchor = &addr_remote;
3911 address_item *addr = addr_remote;
3912 address_item *last = addr;
3913 address_item *next;
3914 uschar * panicmsg;
3915 uschar * serialize_key = NULL;
3916
3917 /* Pull the first address right off the list. */
3918
3919 addr_remote = addr->next;
3920 addr->next = NULL;
3921
3922 DEBUG(D_deliver|D_transport)
3923 debug_printf("--------> %s <--------\n", addr->address);
3924
3925 /* If no transport has been set, there has been a big screw-up somewhere. */
3926
3927 if (!(tp = addr->transport))
3928 {
3929 disable_logging = FALSE; /* Jic */
3930 panicmsg = US"No transport set by router";
3931 goto panic_continue;
3932 }
3933
3934 /* Check that this base address hasn't previously been delivered to this
3935 transport. The check is necessary at this point to handle homonymic addresses
3936 correctly in cases where the pattern of redirection changes between delivery
3937 attempts. Non-homonymic previous delivery is detected earlier, at routing
3938 time. */
3939
3940 if (previously_transported(addr, FALSE)) continue;
3941
3942 /* Force failure if the message is too big. */
3943
3944 if (tp->message_size_limit)
3945 {
3946 int rc = check_message_size(tp, addr);
3947 if (rc != OK)
3948 {
3949 addr->transport_return = rc;
3950 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3951 continue;
3952 }
3953 }
3954
3955 /* Get the flag which specifies whether the transport can handle different
3956 domains that nevertheless resolve to the same set of hosts. If it needs
3957 expanding, get variables set: $address_data, $domain_data, $localpart_data,
3958 $host, $host_address, $host_port. */
3959 if (tp->expand_multi_domain)
3960 deliver_set_expansions(addr);
3961
3962 if (exp_bool(addr, US"transport", tp->name, D_transport,
3963 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
3964 &multi_domain) != OK)
3965 {
3966 deliver_set_expansions(NULL);
3967 panicmsg = addr->message;
3968 goto panic_continue;
3969 }
3970
3971 /* Get the maximum it can handle in one envelope, with zero meaning
3972 unlimited, which is forced for the MUA wrapper case. */
3973
3974 address_count_max = tp->max_addresses;
3975 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3976
3977
3978 /************************************************************************/
3979 /***** This is slightly experimental code, but should be safe. *****/
3980
3981 /* The address_count_max value is the maximum number of addresses that the
3982 transport can send in one envelope. However, the transport must be capable of
3983 dealing with any number of addresses. If the number it gets exceeds its
3984 envelope limitation, it must send multiple copies of the message. This can be
3985 done over a single connection for SMTP, so uses less resources than making
3986 multiple connections. On the other hand, if remote_max_parallel is greater
3987 than one, it is perhaps a good idea to use parallel processing to move the
3988 message faster, even if that results in multiple simultaneous connections to
3989 the same host.
3990
3991 How can we come to some compromise between these two ideals? What we do is to
3992 limit the number of addresses passed to a single instance of a transport to
3993 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3994 number of addresses routed to remote transports divided by
3995 remote_max_parallel. For example, if the message has 100 remote recipients,
3996 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3997 once. But if rcpt_max is 100, we could send up to 100.
3998
3999 Of course, not all the remotely addresses in a message are going to go to the
4000 same set of hosts (except in smarthost configurations), so this is just a
4001 heuristic way of dividing up the work.
4002
4003 Furthermore (1), because this may not be wanted in some cases, and also to
4004 cope with really pathological cases, there is also a limit to the number of
4005 messages that are sent over one connection. This is the same limit that is
4006 used when sending several different messages over the same connection.
4007 Continue_sequence is set when in this situation, to the number sent so
4008 far, including this message.
4009
4010 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4011 is probably because they are using VERP, in which case they want to pass only
4012 one address at a time to the transport, in order to be able to use
4013 $local_part and $domain in constructing a new return path. We could test for
4014 the use of these variables, but as it is so likely they will be used when the
4015 maximum is 1, we don't bother. Just leave the value alone. */
4016
4017 if ( address_count_max != 1
4018 && address_count_max < remote_delivery_count/remote_max_parallel
4019 )
4020 {
4021 int new_max = remote_delivery_count/remote_max_parallel;
4022 int message_max = tp->connection_max_messages;
4023 if (connection_max_messages >= 0) message_max = connection_max_messages;
4024 message_max -= continue_sequence - 1;
4025 if (message_max > 0 && new_max > address_count_max * message_max)
4026 new_max = address_count_max * message_max;
4027 address_count_max = new_max;
4028 }
4029
4030 /************************************************************************/
4031
4032
4033 /* Pick off all addresses which have the same transport, errors address,
4034 destination, and extra headers. In some cases they point to the same host
4035 list, but we also need to check for identical host lists generated from
4036 entirely different domains. The host list pointers can be NULL in the case
4037 where the hosts are defined in the transport. There is also a configured
4038 maximum limit of addresses that can be handled at once (see comments above
4039 for how it is computed).
4040 If the transport does not handle multiple domains, enforce that also,
4041 and if it might need a per-address check for this, re-evaluate it.
4042 */
4043
4044 while ((next = *anchor) && address_count < address_count_max)
4045 {
4046 BOOL md;
4047 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4048 && tp == next->transport
4049 && same_hosts(next->host_list, addr->host_list)
4050 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4051 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4052 && same_ugid(tp, next, addr)
4053 && ( next->prop.remove_headers == addr->prop.remove_headers
4054 || ( next->prop.remove_headers
4055 && addr->prop.remove_headers
4056 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4057 ) )
4058 && ( !multi_domain
4059 || ( (
4060 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
4061 exp_bool(addr,
4062 US"transport", next->transport->name, D_transport,
4063 US"multi_domain", next->transport->multi_domain,
4064 next->transport->expand_multi_domain, &md) == OK
4065 )
4066 && md
4067 ) ) )
4068 {
4069 *anchor = next->next;
4070 next->next = NULL;
4071 next->first = addr; /* remember top one (for retry processing) */
4072 last->next = next;
4073 last = next;
4074 address_count++;
4075 }
4076 else anchor = &(next->next);
4077 deliver_set_expansions(NULL);
4078 }
4079
4080 /* If we are acting as an MUA wrapper, all addresses must go in a single
4081 transaction. If not, put them back on the chain and yield FALSE. */
4082
4083 if (mua_wrapper && addr_remote)
4084 {
4085 last->next = addr_remote;
4086 addr_remote = addr;
4087 return FALSE;
4088 }
4089
4090 /* If the transport is limited for parallellism, enforce that here.
4091 The hints DB entry is decremented in par_reduce(), when we reap the
4092 transport process. */
4093
4094 if (tp->max_parallel)
4095 {
4096 int_eximarith_t max_parallel =
4097 expand_string_integer(tp->max_parallel, TRUE);
4098 if (expand_string_message)
4099 {
4100 panicmsg = expand_string_message;
4101 goto panic_continue;
4102 }
4103 if ( max_parallel > 0
4104 && !enq_start(
4105 serialize_key = string_sprintf("tpt-serialize-%s", tp->name),
4106 (unsigned) max_parallel)
4107 )
4108 {
4109 DEBUG(D_transport)
4110 debug_printf("skipping tpt %s because parallelism limit %u reached\n",
4111 tp->name, (unsigned) max_parallel);
4112
4113 deferlist_chain(addr);
4114 continue;
4115 }
4116 }
4117
4118 /* Set up the expansion variables for this set of addresses */
4119
4120 deliver_set_expansions(addr);
4121
4122 /* Ensure any transport-set auth info is fresh */
4123 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4124
4125 /* Compute the return path, expanding a new one if required. The old one
4126 must be set first, as it might be referred to in the expansion. */
4127
4128 if(addr->prop.errors_address)
4129 return_path = addr->prop.errors_address;
4130#ifdef EXPERIMENTAL_SRS
4131 else if(addr->prop.srs_sender)
4132 return_path = addr->prop.srs_sender;
4133#endif
4134 else
4135 return_path = sender_address;
4136
4137 if (tp->return_path)
4138 {
4139 uschar *new_return_path = expand_string(tp->return_path);
4140 if (new_return_path)
4141 return_path = new_return_path;
4142 else if (!expand_string_forcedfail)
4143 {
4144 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4145 tp->return_path, expand_string_message);
4146 goto enq_continue;
4147 }
4148 }
4149
4150 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4151 logs and sets up error messages, so we just post-process and continue with
4152 the next address. */
4153
4154 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4155 {
4156 panicmsg = NULL;
4157 goto enq_continue;
4158 }
4159
4160 /* If this transport has a setup function, call it now so that it gets
4161 run in this process and not in any subprocess. That way, the results of
4162 any setup that are retained by the transport can be reusable. One of the
4163 things the setup does is to set the fallback host lists in the addresses.
4164 That is why it is called at this point, before the continue delivery
4165 processing, because that might use the fallback hosts. */
4166
4167 if (tp->setup)
4168 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4169
4170 /* If this is a run to continue delivery down an already-established
4171 channel, check that this set of addresses matches the transport and
4172 the channel. If it does not, defer the addresses. If a host list exists,
4173 we must check that the continue host is on the list. Otherwise, the
4174 host is set in the transport. */
4175
4176 continue_more = FALSE; /* In case got set for the last lot */
4177 if (continue_transport)
4178 {
4179 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4180 if (ok && addr->host_list)
4181 {
4182 host_item *h;
4183 ok = FALSE;
4184 for (h = addr->host_list; h; h = h->next)
4185 if (Ustrcmp(h->name, continue_hostname) == 0)
4186 { ok = TRUE; break; }
4187 }
4188
4189 /* Addresses not suitable; defer or queue for fallback hosts (which
4190 might be the continue host) and skip to next address. */
4191
4192 if (!ok)
4193 {
4194 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4195 if (serialize_key) enq_end(serialize_key);
4196
4197 if (addr->fallback_hosts && !fallback)
4198 {
4199 for (next = addr; ; next = next->next)
4200 {
4201 next->host_list = next->fallback_hosts;
4202 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4203 if (!next->next) break;
4204 }
4205 next->next = addr_fallback;
4206 addr_fallback = addr;
4207 }
4208
4209 else
4210 deferlist_chain(addr);
4211
4212 continue;
4213 }
4214
4215 /* Set a flag indicating whether there are further addresses that list
4216 the continued host. This tells the transport to leave the channel open,
4217 but not to pass it to another delivery process. */
4218
4219 for (next = addr_remote; next; next = next->next)
4220 {
4221 host_item *h;
4222 for (h = next->host_list; h; h = h->next)
4223 if (Ustrcmp(h->name, continue_hostname) == 0)
4224 { continue_more = TRUE; break; }
4225 }
4226 }
4227
4228 /* The transports set up the process info themselves as they may connect
4229 to more than one remote machine. They also have to set up the filter
4230 arguments, if required, so that the host name and address are available
4231 for expansion. */
4232
4233 transport_filter_argv = NULL;
4234
4235 /* Create the pipe for inter-process communication. If pipe creation
4236 fails, it is probably because the value of remote_max_parallel is so
4237 large that too many file descriptors for pipes have been created. Arrange
4238 to wait for a process to finish, and then try again. If we still can't
4239 create a pipe when all processes have finished, break the retry loop. */
4240
4241 while (!pipe_done)
4242 {
4243 if (pipe(pfd) == 0) pipe_done = TRUE;
4244 else if (parcount > 0) parmax = parcount;
4245 else break;
4246
4247 /* We need to make the reading end of the pipe non-blocking. There are
4248 two different options for this. Exim is cunningly (I hope!) coded so
4249 that it can use either of them, though it prefers O_NONBLOCK, which
4250 distinguishes between EOF and no-more-data. */
4251
4252#ifdef O_NONBLOCK
4253 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4254#else
4255 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4256#endif
4257
4258 /* If the maximum number of subprocesses already exist, wait for a process
4259 to finish. If we ran out of file descriptors, parmax will have been reduced
4260 from its initial value of remote_max_parallel. */
4261
4262 par_reduce(parmax - 1, fallback);
4263 }
4264
4265 /* If we failed to create a pipe and there were no processes to wait
4266 for, we have to give up on this one. Do this outside the above loop
4267 so that we can continue the main loop. */
4268
4269 if (!pipe_done)
4270 {
4271 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4272 goto enq_continue;
4273 }
4274
4275 /* Find a free slot in the pardata list. Must do this after the possible
4276 waiting for processes to finish, because a terminating process will free
4277 up a slot. */
4278
4279 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4280 if (parlist[poffset].pid == 0)
4281 break;
4282
4283 /* If there isn't one, there has been a horrible disaster. */
4284
4285 if (poffset >= remote_max_parallel)
4286 {
4287 (void)close(pfd[pipe_write]);
4288 (void)close(pfd[pipe_read]);
4289 panicmsg = US"Unexpectedly no free subprocess slot";
4290 goto enq_continue;
4291 }
4292
4293 /* Now fork a subprocess to do the remote delivery, but before doing so,
4294 ensure that any cached resourses are released so as not to interfere with
4295 what happens in the subprocess. */
4296
4297 search_tidyup();
4298
4299 if ((pid = fork()) == 0)
4300 {
4301 int fd = pfd[pipe_write];
4302 host_item *h;
4303
4304 /* Setting this global in the subprocess means we need never clear it */
4305 transport_name = tp->name;
4306
4307 /* There are weird circumstances in which logging is disabled */
4308 disable_logging = tp->disable_logging;
4309
4310 /* Show pids on debug output if parallelism possible */
4311
4312 if (parmax > 1 && (parcount > 0 || addr_remote))
4313 {
4314 DEBUG(D_any|D_v) debug_selector |= D_pid;
4315 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4316 }
4317
4318 /* Reset the random number generator, so different processes don't all
4319 have the same sequence. In the test harness we want different, but
4320 predictable settings for each delivery process, so do something explicit
4321 here rather they rely on the fixed reset in the random number function. */
4322
4323 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4324
4325 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4326 a new process that may be forked to do another delivery down the same
4327 SMTP connection. */
4328
4329 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4330
4331 /* Close open file descriptors for the pipes of other processes
4332 that are running in parallel. */
4333
4334 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4335 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4336
4337 /* This process has inherited a copy of the file descriptor
4338 for the data file, but its file pointer is shared with all the
4339 other processes running in parallel. Therefore, we have to re-open
4340 the file in order to get a new file descriptor with its own
4341 file pointer. We don't need to lock it, as the lock is held by
4342 the parent process. There doesn't seem to be any way of doing
4343 a dup-with-new-file-pointer. */
4344
4345 (void)close(deliver_datafile);
4346 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4347 message_id);
4348 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4349
4350 if (deliver_datafile < 0)
4351 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4352 "parallel delivery: %s", spoolname, strerror(errno));
4353
4354 /* Set the close-on-exec flag */
4355
4356 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4357 FD_CLOEXEC);
4358
4359 /* Set the uid/gid of this process; bombs out on failure. */
4360
4361 exim_setugid(uid, gid, use_initgroups,
4362 string_sprintf("remote delivery to %s with transport=%s",
4363 addr->address, tp->name));
4364
4365 /* Close the unwanted half of this process' pipe, set the process state,
4366 and run the transport. Afterwards, transport_count will contain the number
4367 of bytes written. */
4368
4369 (void)close(pfd[pipe_read]);
4370 set_process_info("delivering %s using %s", message_id, tp->name);
4371 debug_print_string(tp->debug_string);
4372 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4373
4374 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4375 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4376
4377 /* Ensure any cached resources that we used are now released */
4378
4379 search_tidyup();
4380
4381 /* Pass the result back down the pipe. This is a lot more information
4382 than is needed for a local delivery. We have to send back the error
4383 status for each address, the usability status for each host that is
4384 flagged as unusable, and all the retry items. When TLS is in use, we
4385 send also the cipher and peerdn information. Each type of information
4386 is flagged by an identifying byte, and is then in a fixed format (with
4387 strings terminated by zeros), and there is a final terminator at the
4388 end. The host information and retry information is all attached to
4389 the first address, so that gets sent at the start. */
4390
4391 /* Host unusability information: for most success cases this will
4392 be null. */
4393
4394 for (h = addr->host_list; h; h = h->next)
4395 {
4396 if (!h->address || h->status < hstatus_unusable) continue;
4397 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4398 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4399 }
4400
4401 /* The number of bytes written. This is the same for each address. Even
4402 if we sent several copies of the message down the same connection, the
4403 size of each one is the same, and it's that value we have got because
4404 transport_count gets reset before calling transport_write_message(). */
4405
4406 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4407 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4408
4409 /* Information about what happened to each address. Four item types are
4410 used: an optional 'X' item first, for TLS information, then an optional "C"
4411 item for any client-auth info followed by 'R' items for any retry settings,
4412 and finally an 'A' item for the remaining data. */
4413
4414 for(; addr; addr = addr->next)
4415 {
4416 uschar *ptr;
4417 retry_item *r;
4418
4419 /* The certificate verification status goes into the flags */
4420 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4421#ifdef EXPERIMENTAL_DANE
4422 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4423#endif
4424
4425 /* Use an X item only if there's something to send */
4426#ifdef SUPPORT_TLS
4427 if (addr->cipher)
4428 {
4429 ptr = big_buffer;
4430 sprintf(CS ptr, "%.128s", addr->cipher);
4431 while(*ptr++);
4432 if (!addr->peerdn)
4433 *ptr++ = 0;
4434 else
4435 {
4436 sprintf(CS ptr, "%.512s", addr->peerdn);
4437 while(*ptr++);
4438 }
4439
4440 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4441 }
4442 if (addr->peercert)
4443 {
4444 ptr = big_buffer;
4445 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4446 while(*ptr++);
4447 else
4448 *ptr++ = 0;
4449 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4450 }
4451 if (addr->ourcert)
4452 {
4453 ptr = big_buffer;
4454 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4455 while(*ptr++);
4456 else
4457 *ptr++ = 0;
4458 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4459 }
4460# ifndef DISABLE_OCSP
4461 if (addr->ocsp > OCSP_NOT_REQ)
4462 {
4463 ptr = big_buffer;
4464 sprintf(CS ptr, "%c", addr->ocsp + '0');
4465 while(*ptr++);
4466 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4467 }
4468# endif
4469#endif /*SUPPORT_TLS*/
4470
4471 if (client_authenticator)
4472 {
4473 ptr = big_buffer;
4474 sprintf(CS big_buffer, "%.64s", client_authenticator);
4475 while(*ptr++);
4476 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4477 }
4478 if (client_authenticated_id)
4479 {
4480 ptr = big_buffer;
4481 sprintf(CS big_buffer, "%.64s", client_authenticated_id);
4482 while(*ptr++);
4483 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4484 }
4485 if (client_authenticated_sender)
4486 {
4487 ptr = big_buffer;
4488 sprintf(CS big_buffer, "%.64s", client_authenticated_sender);
4489 while(*ptr++);
4490 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4491 }
4492
4493#ifndef DISABLE_PRDR
4494 if (addr->flags & af_prdr_used)
4495 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4496#endif
4497
4498 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4499 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4500 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4501
4502 /* Retry information: for most success cases this will be null. */
4503
4504 for (r = addr->retries; r; r = r->next)
4505 {
4506 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4507 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4508 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4509 ptr += sizeof(r->basic_errno);
4510 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4511 ptr += sizeof(r->more_errno);
4512 if (!r->message) *ptr++ = 0; else
4513 {
4514 sprintf(CS ptr, "%.512s", r->message);
4515 while(*ptr++);
4516 }
4517 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4518 }
4519
4520#ifdef EXPERIMENTAL_DSN_INFO
4521/*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4522 if (addr->smtp_greeting)
4523 {
4524 ptr = big_buffer;
4525 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4526 sprintf(CS ptr, "%.128s", addr->smtp_greeting);
4527 while(*ptr++);
4528 if (addr->helo_response)
4529 {
4530 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4531 sprintf(CS ptr, "%.128s", addr->helo_response);
4532 while(*ptr++);
4533 }
4534 else
4535 *ptr++ = '\0';
4536 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4537 }
4538#endif
4539
4540 /* The rest of the information goes in an 'A0' item. */
4541
4542 sprintf(CS big_buffer, "%c%c", addr->transport_return,
4543 addr->special_action);
4544 ptr = big_buffer + 2;
4545 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4546 ptr += sizeof(addr->basic_errno);
4547 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4548 ptr += sizeof(addr->more_errno);
4549 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4550 ptr += sizeof(addr->flags);
4551
4552 if (!addr->message) *ptr++ = 0; else
4553 {
4554 sprintf(CS ptr, "%.1024s", addr->message);
4555 while(*ptr++);
4556 }
4557
4558 if (!addr->user_message) *ptr++ = 0; else
4559 {
4560 sprintf(CS ptr, "%.1024s", addr->user_message);
4561 while(*ptr++);
4562 }
4563
4564 if (!addr->host_used) *ptr++ = 0; else
4565 {
4566 sprintf(CS ptr, "%.256s", addr->host_used->name);
4567 while(*ptr++);
4568 sprintf(CS ptr, "%.64s", addr->host_used->address);
4569 while(*ptr++);
4570 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4571 ptr += sizeof(addr->host_used->port);
4572
4573 /* DNS lookup status */
4574 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4575 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4576
4577 }
4578 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4579 }
4580
4581 /* Local interface address/port */
4582#ifdef EXPERIMENTAL_DSN_INFO
4583 if (sending_ip_address)
4584#else
4585 if (LOGGING(incoming_interface) && sending_ip_address)
4586#endif
4587 {
4588 uschar * ptr = big_buffer;
4589 sprintf(CS ptr, "%.128s", sending_ip_address);
4590 while(*ptr++);
4591 sprintf(CS ptr, "%d", sending_port);
4592 while(*ptr++);
4593
4594 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4595 }
4596
4597 /* Add termination flag, close the pipe, and that's it. The character
4598 after 'Z' indicates whether continue_transport is now NULL or not.
4599 A change from non-NULL to NULL indicates a problem with a continuing
4600 connection. */
4601
4602 big_buffer[0] = continue_transport ? '1' : '0';
4603 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4604 (void)close(fd);
4605 exit(EXIT_SUCCESS);
4606 }
4607
4608 /* Back in the mainline: close the unwanted half of the pipe. */
4609
4610 (void)close(pfd[pipe_write]);
4611
4612 /* Fork failed; defer with error message */
4613
4614 if (pid < 0)
4615 {
4616 (void)close(pfd[pipe_read]);
4617 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
4618 addr->domain, strerror(errno));
4619 goto enq_continue;
4620 }
4621
4622 /* Fork succeeded; increment the count, and remember relevant data for
4623 when the process finishes. */
4624
4625 parcount++;
4626 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4627 parlist[poffset].pid = pid;
4628 parlist[poffset].fd = pfd[pipe_read];
4629 parlist[poffset].done = FALSE;
4630 parlist[poffset].msg = NULL;
4631 parlist[poffset].return_path = return_path;
4632
4633 /* If the process we've just started is sending a message down an existing
4634 channel, wait for it now. This ensures that only one such process runs at
4635 once, whatever the value of remote_max parallel. Otherwise, we might try to
4636 send two or more messages simultaneously down the same channel. This could
4637 happen if there are different domains that include the same host in otherwise
4638 different host lists.
4639
4640 Also, if the transport closes down the channel, this information gets back
4641 (continue_transport gets set to NULL) before we consider any other addresses
4642 in this message. */
4643
4644 if (continue_transport) par_reduce(0, fallback);
4645
4646 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4647 newly created process get going before we create another process. This should
4648 ensure repeatability in the tests. We only need to wait a tad. */
4649
4650 else if (running_in_test_harness) millisleep(500);
4651
4652 continue;
4653
4654enq_continue:
4655 if (serialize_key) enq_end(serialize_key);
4656panic_continue:
4657 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
4658 continue;
4659 }
4660
4661/* Reached the end of the list of addresses. Wait for all the subprocesses that
4662are still running and post-process their addresses. */
4663
4664par_reduce(0, fallback);
4665return TRUE;
4666}
4667
4668
4669
4670
4671/*************************************************
4672* Split an address into local part and domain *
4673*************************************************/
4674
4675/* This function initializes an address for routing by splitting it up into a
4676local part and a domain. The local part is set up twice - once in its original
4677casing, and once in lower case, and it is dequoted. We also do the "percent
4678hack" for configured domains. This may lead to a DEFER result if a lookup
4679defers. When a percent-hacking takes place, we insert a copy of the original
4680address as a new parent of this address, as if we have had a redirection.
4681
4682Argument:
4683 addr points to an addr_item block containing the address
4684
4685Returns: OK
4686 DEFER - could not determine if domain is %-hackable
4687*/
4688
4689int
4690deliver_split_address(address_item *addr)
4691{
4692uschar *address = addr->address;
4693uschar *domain = Ustrrchr(address, '@');
4694uschar *t;
4695int len = domain - address;
4696
4697addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4698
4699/* The implication in the RFCs (though I can't say I've seen it spelled out
4700explicitly) is that quoting should be removed from local parts at the point
4701where they are locally interpreted. [The new draft "821" is more explicit on
4702this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4703removing quoting backslashes and any unquoted doublequotes. */
4704
4705t = addr->cc_local_part = store_get(len+1);
4706while(len-- > 0)
4707 {
4708 register int c = *address++;
4709 if (c == '\"') continue;
4710 if (c == '\\')
4711 {
4712 *t++ = *address++;
4713 len--;
4714 }
4715 else *t++ = c;
4716 }
4717*t = 0;
4718
4719/* We do the percent hack only for those domains that are listed in
4720percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4721
4722if (percent_hack_domains)
4723 {
4724 int rc;
4725 uschar *new_address = NULL;
4726 uschar *local_part = addr->cc_local_part;
4727
4728 deliver_domain = addr->domain; /* set $domain */
4729
4730 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
4731 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4732 == OK
4733 && (t = Ustrrchr(local_part, '%')) != NULL
4734 )
4735 {
4736 new_address = string_copy(local_part);
4737 new_address[t - local_part] = '@';
4738 deliver_domain = string_copylc(t+1);
4739 local_part = string_copyn(local_part, t - local_part);
4740 }
4741
4742 if (rc == DEFER) return DEFER; /* lookup deferred */
4743
4744 /* If hackery happened, set up new parent and alter the current address. */
4745
4746 if (new_address)
4747 {
4748 address_item *new_parent = store_get(sizeof(address_item));
4749 *new_parent = *addr;
4750 addr->parent = new_parent;
4751 addr->address = new_address;
4752 addr->unique = string_copy(new_address);
4753 addr->domain = deliver_domain;
4754 addr->cc_local_part = local_part;
4755 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4756 addr->address);
4757 }
4758 }
4759
4760/* Create the lowercased version of the final local part, and make that the
4761default one to be used. */
4762
4763addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4764return OK;
4765}
4766
4767
4768
4769
4770/*************************************************
4771* Get next error message text *
4772*************************************************/
4773
4774/* If f is not NULL, read the next "paragraph", from a customized error message
4775text file, terminated by a line containing ****, and expand it.
4776
4777Arguments:
4778 f NULL or a file to read from
4779 which string indicating which string (for errors)
4780
4781Returns: NULL or an expanded string
4782*/
4783
4784static uschar *
4785next_emf(FILE *f, uschar *which)
4786{
4787int size = 256;
4788int ptr = 0;
4789uschar *para, *yield;
4790uschar buffer[256];
4791
4792if (!f) return NULL;
4793
4794if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
4795 return NULL;
4796
4797para = store_get(size);
4798for (;;)
4799 {
4800 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4801 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
4802 break;
4803 }
4804para[ptr] = 0;
4805
4806if ((yield = expand_string(para)))
4807 return yield;
4808
4809log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4810 "bounce_message_file or warn_message_file (%s): %s", which,
4811 expand_string_message);
4812return NULL;
4813}
4814
4815
4816
4817
4818/*************************************************
4819* Close down a passed transport channel *
4820*************************************************/
4821
4822/* This function is called when a passed transport channel cannot be used.
4823It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4824so that the function call can be the argument of a "return" statement.
4825
4826Arguments: None
4827Returns: DELIVER_NOT_ATTEMPTED
4828*/
4829
4830static int
4831continue_closedown(void)
4832{
4833if (continue_transport)
4834 {
4835 transport_instance *t;
4836 for (t = transports; t; t = t->next)
4837 if (Ustrcmp(t->name, continue_transport) == 0)
4838 {
4839 if (t->info->closedown) (t->info->closedown)(t);
4840 break;
4841 }
4842 }
4843return DELIVER_NOT_ATTEMPTED;
4844}
4845
4846
4847
4848
4849/*************************************************
4850* Print address information *
4851*************************************************/
4852
4853/* This function is called to output an address, or information about an
4854address, for bounce or defer messages. If the hide_child flag is set, all we
4855output is the original ancestor address.
4856
4857Arguments:
4858 addr points to the address
4859 f the FILE to print to
4860 si an initial string
4861 sc a continuation string for before "generated"
4862 se an end string
4863
4864Returns: TRUE if the address is not hidden
4865*/
4866
4867static BOOL
4868print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4869 uschar *se)
4870{
4871BOOL yield = TRUE;
4872uschar *printed = US"";
4873address_item *ancestor = addr;
4874while (ancestor->parent) ancestor = ancestor->parent;
4875
4876fprintf(f, "%s", CS si);
4877
4878if (addr->parent && testflag(addr, af_hide_child))
4879 {
4880 printed = US"an undisclosed address";
4881 yield = FALSE;
4882 }
4883else if (!testflag(addr, af_pfr) || !addr->parent)
4884 printed = addr->address;
4885
4886else
4887 {
4888 uschar *s = addr->address;
4889 uschar *ss;
4890
4891 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4892 else if (addr->address[0] == '|') ss = US"pipe";
4893 else ss = US"save";
4894
4895 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4896 printed = addr->parent->address;
4897 }
4898
4899fprintf(f, "%s", CS string_printing(printed));
4900
4901if (ancestor != addr)
4902 {
4903 uschar *original = ancestor->onetime_parent;
4904 if (!original) original= ancestor->address;
4905 if (strcmpic(original, printed) != 0)
4906 fprintf(f, "%s(%sgenerated from %s)", sc,
4907 ancestor != addr->parent ? "ultimately " : "",
4908 string_printing(original));
4909 }
4910
4911if (addr->host_used)
4912 fprintf(f, "\n host %s [%s]",
4913 addr->host_used->name, addr->host_used->address);
4914
4915fprintf(f, "%s", CS se);
4916return yield;
4917}
4918
4919
4920
4921
4922
4923/*************************************************
4924* Print error for an address *
4925*************************************************/
4926
4927/* This function is called to print the error information out of an address for
4928a bounce or a warning message. It tries to format the message reasonably by
4929introducing newlines. All lines are indented by 4; the initial printing
4930position must be set before calling.
4931
4932This function used always to print the error. Nowadays we want to restrict it
4933to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4934and filter "fail". We no longer pass other information willy-nilly in bounce
4935and warning messages. Text in user_message is always output; text in message
4936only if the af_pass_message flag is set.
4937
4938Arguments:
4939 addr the address
4940 f the FILE to print on
4941 t some leading text
4942
4943Returns: nothing
4944*/
4945
4946static void
4947print_address_error(address_item *addr, FILE *f, uschar *t)
4948{
4949int count = Ustrlen(t);
4950uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4951
4952if (!s && !(s = addr->user_message))
4953 return;
4954
4955fprintf(f, "\n %s", t);
4956
4957while (*s)
4958 if (*s == '\\' && s[1] == 'n')
4959 {
4960 fprintf(f, "\n ");
4961 s += 2;
4962 count = 0;
4963 }
4964 else
4965 {
4966 fputc(*s, f);
4967 count++;
4968 if (*s++ == ':' && isspace(*s) && count > 45)
4969 {
4970 fprintf(f, "\n "); /* sic (because space follows) */
4971 count = 0;
4972 }
4973 }
4974}
4975
4976
4977/***********************************************************
4978* Print Diagnostic-Code for an address *
4979************************************************************/
4980
4981/* This function is called to print the error information out of an address for
4982a bounce or a warning message. It tries to format the message reasonably as
4983required by RFC 3461 by adding a space after each newline
4984
4985it uses the same logic as print_address_error() above. if af_pass_message is true
4986and addr->message is set it uses the remote host answer. if not addr->user_message
4987is used instead if available.
4988
4989Arguments:
4990 addr the address
4991 f the FILE to print on
4992
4993Returns: nothing
4994*/
4995
4996static void
4997print_dsn_diagnostic_code(const address_item *addr, FILE *f)
4998{
4999uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5000
5001/* af_pass_message and addr->message set ? print remote host answer */
5002if (s)
5003 {
5004 DEBUG(D_deliver)
5005 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5006
5007 /* search first ": ". we assume to find the remote-MTA answer there */
5008 if (!(s = Ustrstr(addr->message, ": ")))
5009 return; /* not found, bail out */
5010 s += 2; /* skip ": " */
5011 fprintf(f, "Diagnostic-Code: smtp; ");
5012 }
5013/* no message available. do nothing */
5014else return;
5015
5016while (*s)
5017 if (*s == '\\' && s[1] == 'n')
5018 {
5019 fputs("\n ", f); /* as defined in RFC 3461 */
5020 s += 2;
5021 }
5022 else
5023 fputc(*s++, f);
5024
5025fputc('\n', f);
5026}
5027
5028
5029/*************************************************
5030* Check list of addresses for duplication *
5031*************************************************/
5032
5033/* This function was introduced when the test for duplicate addresses that are
5034not pipes, files, or autoreplies was moved from the middle of routing to when
5035routing was complete. That was to fix obscure cases when the routing history
5036affects the subsequent routing of identical addresses. This function is called
5037after routing, to check that the final routed addresses are not duplicates.
5038
5039If we detect a duplicate, we remember what it is a duplicate of. Note that
5040pipe, file, and autoreply de-duplication is handled during routing, so we must
5041leave such "addresses" alone here, as otherwise they will incorrectly be
5042discarded.
5043
5044Argument: address of list anchor
5045Returns: nothing
5046*/
5047
5048static void
5049do_duplicate_check(address_item **anchor)
5050{
5051address_item *addr;
5052while ((addr = *anchor))
5053 {
5054 tree_node *tnode;
5055 if (testflag(addr, af_pfr))
5056 {
5057 anchor = &(addr->next);
5058 }
5059 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5060 {
5061 DEBUG(D_deliver|D_route)
5062 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5063 *anchor = addr->next;
5064 addr->dupof = tnode->data.ptr;
5065 addr->next = addr_duplicate;
5066 addr_duplicate = addr;
5067 }
5068 else
5069 {
5070 tree_add_duplicate(addr->unique, addr);
5071 anchor = &(addr->next);
5072 }
5073 }
5074}
5075
5076
5077
5078
5079/*************************************************
5080* Deliver one message *
5081*************************************************/
5082
5083/* This is the function which is called when a message is to be delivered. It
5084is passed the id of the message. It is possible that the message no longer
5085exists, if some other process has delivered it, and it is also possible that
5086the message is being worked on by another process, in which case the data file
5087will be locked.
5088
5089If no delivery is attempted for any of the above reasons, the function returns
5090DELIVER_NOT_ATTEMPTED.
5091
5092If the give_up flag is set true, do not attempt any deliveries, but instead
5093fail all outstanding addresses and return the message to the sender (or
5094whoever).
5095
5096A delivery operation has a process all to itself; we never deliver more than
5097one message in the same process. Therefore we needn't worry too much about
5098store leakage.
5099
5100Arguments:
5101 id the id of the message to be delivered
5102 forced TRUE if delivery was forced by an administrator; this overrides
5103 retry delays and causes a delivery to be tried regardless
5104 give_up TRUE if an administrator has requested that delivery attempts
5105 be abandoned
5106
5107Returns: When the global variable mua_wrapper is FALSE:
5108 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5109 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5110 When the global variable mua_wrapper is TRUE:
5111 DELIVER_MUA_SUCCEEDED if delivery succeeded
5112 DELIVER_MUA_FAILED if delivery failed
5113 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5114*/
5115
5116int
5117deliver_message(uschar *id, BOOL forced, BOOL give_up)
5118{
5119int i, rc;
5120int final_yield = DELIVER_ATTEMPTED_NORMAL;
5121time_t now = time(NULL);
5122address_item *addr_last = NULL;
5123uschar *filter_message = NULL;
5124FILE *jread;
5125int process_recipients = RECIP_ACCEPT;
5126open_db dbblock;
5127open_db *dbm_file;
5128extern int acl_where;
5129
5130uschar *info = queue_run_pid == (pid_t)0
5131 ? string_sprintf("delivering %s", id)
5132 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5133
5134/* If the D_process_info bit is on, set_process_info() will output debugging
5135information. If not, we want to show this initial information if D_deliver or
5136D_queue_run is set or in verbose mode. */
5137
5138set_process_info("%s", info);
5139
5140if ( !(debug_selector & D_process_info)
5141 && (debug_selector & (D_deliver|D_queue_run|D_v))
5142 )
5143 debug_printf("%s\n", info);
5144
5145/* Ensure that we catch any subprocesses that are created. Although Exim
5146sets SIG_DFL as its initial default, some routes through the code end up
5147here with it set to SIG_IGN - cases where a non-synchronous delivery process
5148has been forked, but no re-exec has been done. We use sigaction rather than
5149plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5150sure it is turned off. (There was a problem on AIX with this.) */
5151
5152#ifdef SA_NOCLDWAIT
5153 {
5154 struct sigaction act;
5155 act.sa_handler = SIG_DFL;
5156 sigemptyset(&(act.sa_mask));
5157 act.sa_flags = 0;
5158 sigaction(SIGCHLD, &act, NULL);
5159 }
5160#else
5161signal(SIGCHLD, SIG_DFL);
5162#endif
5163
5164/* Make the forcing flag available for routers and transports, set up the
5165global message id field, and initialize the count for returned files and the
5166message size. This use of strcpy() is OK because the length id is checked when
5167it is obtained from a command line (the -M or -q options), and otherwise it is
5168known to be a valid message id. */
5169
5170Ustrcpy(message_id, id);
5171deliver_force = forced;
5172return_count = 0;
5173message_size = 0;
5174
5175/* Initialize some flags */
5176
5177update_spool = FALSE;
5178remove_journal = TRUE;
5179
5180/* Set a known context for any ACLs we call via expansions */
5181acl_where = ACL_WHERE_DELIVERY;
5182
5183/* Reset the random number generator, so that if several delivery processes are
5184started from a queue runner that has already used random numbers (for sorting),
5185they don't all get the same sequence. */
5186
5187random_seed = 0;
5188
5189/* Open and lock the message's data file. Exim locks on this one because the
5190header file may get replaced as it is re-written during the delivery process.
5191Any failures cause messages to be written to the log, except for missing files
5192while queue running - another process probably completed delivery. As part of
5193opening the data file, message_subdir gets set. */
5194
5195if (!spool_open_datafile(id))
5196 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5197
5198/* The value of message_size at this point has been set to the data length,
5199plus one for the blank line that notionally precedes the data. */
5200
5201/* Now read the contents of the header file, which will set up the headers in
5202store, and also the list of recipients and the tree of non-recipients and
5203assorted flags. It updates message_size. If there is a reading or format error,
5204give up; if the message has been around for sufficiently long, remove it. */
5205
5206sprintf(CS spoolname, "%s-H", id);
5207if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5208 {
5209 if (errno == ERRNO_SPOOLFORMAT)
5210 {
5211 struct stat statbuf;
5212 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
5213 spoolname);
5214 if (Ustat(big_buffer, &statbuf) == 0)
5215 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5216 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5217 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5218 }
5219 else
5220 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5221 strerror(errno));
5222
5223 /* If we managed to read the envelope data, received_time contains the
5224 time the message was received. Otherwise, we can calculate it from the
5225 message id. */
5226
5227 if (rc != spool_read_hdrerror)
5228 {
5229 received_time = 0;
5230 for (i = 0; i < 6; i++)
5231 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5232 }
5233
5234 /* If we've had this malformed message too long, sling it. */
5235
5236 if (now - received_time > keep_malformed)
5237 {
5238 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5239 Uunlink(spoolname);
5240 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
5241 Uunlink(spoolname);
5242 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
5243 Uunlink(spoolname);
5244 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5245 Uunlink(spoolname);
5246 log_write(0, LOG_MAIN, "Message removed because older than %s",
5247 readconf_printtime(keep_malformed));
5248 }
5249
5250 (void)close(deliver_datafile);
5251 deliver_datafile = -1;
5252 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5253 }
5254
5255/* The spool header file has been read. Look to see if there is an existing
5256journal file for this message. If there is, it means that a previous delivery
5257attempt crashed (program or host) before it could update the spool header file.
5258Read the list of delivered addresses from the journal and add them to the
5259nonrecipients tree. Then update the spool file. We can leave the journal in
5260existence, as it will get further successful deliveries added to it in this
5261run, and it will be deleted if this function gets to its end successfully.
5262Otherwise it might be needed again. */
5263
5264sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5265jread = Ufopen(spoolname, "rb");
5266if (jread)
5267 {
5268 while (Ufgets(big_buffer, big_buffer_size, jread))
5269 {
5270 int n = Ustrlen(big_buffer);
5271 big_buffer[n-1] = 0;
5272 tree_add_nonrecipient(big_buffer);
5273 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5274 "journal file\n", big_buffer);
5275 }
5276 (void)fclose(jread);
5277 /* Panic-dies on error */
5278 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5279 }
5280else if (errno != ENOENT)
5281 {
5282 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5283 "%s", strerror(errno));
5284 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5285 }
5286
5287/* A null recipients list indicates some kind of disaster. */
5288
5289if (!recipients_list)
5290 {
5291 (void)close(deliver_datafile);
5292 deliver_datafile = -1;
5293 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
5294 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5295 }
5296
5297
5298/* Handle a message that is frozen. There are a number of different things that
5299can happen, but in the default situation, unless forced, no delivery is
5300attempted. */
5301
5302if (deliver_freeze)
5303 {
5304#ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5305 /* Moving to another directory removes the message from Exim's view. Other
5306 tools must be used to deal with it. Logging of this action happens in
5307 spool_move_message() and its subfunctions. */
5308
5309 if ( move_frozen_messages
5310 && spool_move_message(id, message_subdir, US"", US"F")
5311 )
5312 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5313#endif
5314
5315 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5316 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5317 flag causing all recipients to be failed. The time is the age of the
5318 message, not the time since freezing. */
5319
5320 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5321 {
5322 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5323 process_recipients = RECIP_FAIL_TIMEOUT;
5324 }
5325
5326 /* For bounce messages (and others with no sender), thaw if the error message
5327 ignore timer is exceeded. The message will be discarded if this delivery
5328 fails. */
5329
5330 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5331 {
5332 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5333 }
5334
5335 /* If this is a bounce message, or there's no auto thaw, or we haven't
5336 reached the auto thaw time yet, and this delivery is not forced by an admin
5337 user, do not attempt delivery of this message. Note that forced is set for
5338 continuing messages down the same channel, in order to skip load checking and
5339 ignore hold domains, but we don't want unfreezing in that case. */
5340
5341 else
5342 {
5343 if ( ( sender_address[0] == 0
5344 || auto_thaw <= 0
5345 || now <= deliver_frozen_at + auto_thaw
5346 )
5347 && ( !forced || !deliver_force_thaw
5348 || !admin_user || continue_hostname
5349 ) )
5350 {
5351 (void)close(deliver_datafile);
5352 deliver_datafile = -1;
5353 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5354 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5355 }
5356
5357 /* If delivery was forced (by an admin user), assume a manual thaw.
5358 Otherwise it's an auto thaw. */
5359
5360 if (forced)
5361 {
5362 deliver_manual_thaw = TRUE;
5363 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5364 }
5365 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5366 }
5367
5368 /* We get here if any of the rules for unfreezing have triggered. */
5369
5370 deliver_freeze = FALSE;
5371 update_spool = TRUE;
5372 }
5373
5374
5375/* Open the message log file if we are using them. This records details of
5376deliveries, deferments, and failures for the benefit of the mail administrator.
5377The log is not used by exim itself to track the progress of a message; that is
5378done by rewriting the header spool file. */
5379
5380if (message_logs)
5381 {
5382 uschar *error;
5383 int fd;
5384
5385 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5386 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5387
5388 if (fd < 0)
5389 {
5390 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5391 spoolname, strerror(errno));
5392 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5393 }
5394
5395 /* Make a C stream out of it. */
5396
5397 if (!(message_log = fdopen(fd, "a")))
5398 {
5399 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5400 spoolname, strerror(errno));
5401 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5402 }
5403 }
5404
5405
5406/* If asked to give up on a message, log who did it, and set the action for all
5407the addresses. */
5408
5409if (give_up)
5410 {
5411 struct passwd *pw = getpwuid(real_uid);
5412 log_write(0, LOG_MAIN, "cancelled by %s",
5413 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5414 process_recipients = RECIP_FAIL;
5415 }
5416
5417/* Otherwise, if there are too many Received: headers, fail all recipients. */
5418
5419else if (received_count > received_headers_max)
5420 process_recipients = RECIP_FAIL_LOOP;
5421
5422/* Otherwise, if a system-wide, address-independent message filter is
5423specified, run it now, except in the case when we are failing all recipients as
5424a result of timeout_frozen_after. If the system filter yields "delivered", then
5425ignore the true recipients of the message. Failure of the filter file is
5426logged, and the delivery attempt fails. */
5427
5428else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5429 {
5430 int rc;
5431 int filtertype;
5432 ugid_block ugid;
5433 redirect_block redirect;
5434
5435 if (system_filter_uid_set)
5436 {
5437 ugid.uid = system_filter_uid;
5438 ugid.gid = system_filter_gid;
5439 ugid.uid_set = ugid.gid_set = TRUE;
5440 }
5441 else
5442 {
5443 ugid.uid_set = ugid.gid_set = FALSE;
5444 }
5445
5446 return_path = sender_address;
5447 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5448 system_filtering = TRUE;
5449
5450 /* Any error in the filter file causes a delivery to be abandoned. */
5451
5452 redirect.string = system_filter;
5453 redirect.isfile = TRUE;
5454 redirect.check_owner = redirect.check_group = FALSE;
5455 redirect.owners = NULL;
5456 redirect.owngroups = NULL;
5457 redirect.pw = NULL;
5458 redirect.modemask = 0;
5459
5460 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5461
5462 rc = rda_interpret(
5463 &redirect, /* Where the data is */
5464 RDO_DEFER | /* Turn on all the enabling options */
5465 RDO_FAIL | /* Leave off all the disabling options */
5466 RDO_FILTER |
5467 RDO_FREEZE |
5468 RDO_REALLOG |
5469 RDO_REWRITE,
5470 NULL, /* No :include: restriction (not used in filter) */
5471 NULL, /* No sieve vacation directory (not sieve!) */
5472 NULL, /* No sieve enotify mailto owner (not sieve!) */
5473 NULL, /* No sieve user address (not sieve!) */
5474 NULL, /* No sieve subaddress (not sieve!) */
5475 &ugid, /* uid/gid data */
5476 &addr_new, /* Where to hang generated addresses */
5477 &filter_message, /* Where to put error message */
5478 NULL, /* Don't skip syntax errors */
5479 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5480 US"system filter"); /* For error messages */
5481
5482 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5483
5484 if (rc == FF_ERROR || rc == FF_NONEXIST)
5485 {
5486 (void)close(deliver_datafile);
5487 deliver_datafile = -1;
5488 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5489 string_printing(filter_message));
5490 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5491 }
5492
5493 /* Reset things. If the filter message is an empty string, which can happen
5494 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5495
5496 system_filtering = FALSE;
5497 enable_dollar_recipients = FALSE;
5498 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5499
5500 /* Save the values of the system filter variables so that user filters
5501 can use them. */
5502
5503 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5504
5505 /* The filter can request that delivery of the original addresses be
5506 deferred. */
5507
5508 if (rc == FF_DEFER)
5509 {
5510 process_recipients = RECIP_DEFER;
5511 deliver_msglog("Delivery deferred by system filter\n");
5512 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5513 }
5514
5515 /* The filter can request that a message be frozen, but this does not
5516 take place if the message has been manually thawed. In that case, we must
5517 unset "delivered", which is forced by the "freeze" command to make -bF
5518 work properly. */
5519
5520 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5521 {
5522 deliver_freeze = TRUE;
5523 deliver_frozen_at = time(NULL);
5524 process_recipients = RECIP_DEFER;
5525 frozen_info = string_sprintf(" by the system filter%s%s",
5526 filter_message ? US": " : US"",
5527 filter_message ? filter_message : US"");
5528 }
5529
5530 /* The filter can request that a message be failed. The error message may be
5531 quite long - it is sent back to the sender in the bounce - but we don't want
5532 to fill up the log with repetitions of it. If it starts with << then the text
5533 between << and >> is written to the log, with the rest left for the bounce
5534 message. */
5535
5536 else if (rc == FF_FAIL)
5537 {
5538 uschar *colon = US"";
5539 uschar *logmsg = US"";
5540 int loglen = 0;
5541
5542 process_recipients = RECIP_FAIL_FILTER;
5543
5544 if (filter_message)
5545 {
5546 uschar *logend;
5547 colon = US": ";
5548 if ( filter_message[0] == '<'
5549 && filter_message[1] == '<'
5550 && (logend = Ustrstr(filter_message, ">>"))
5551 )
5552 {
5553 logmsg = filter_message + 2;
5554 loglen = logend - logmsg;
5555 filter_message = logend + 2;
5556 if (filter_message[0] == 0) filter_message = NULL;
5557 }
5558 else
5559 {
5560 logmsg = filter_message;
5561 loglen = Ustrlen(filter_message);
5562 }
5563 }
5564
5565 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5566 logmsg);
5567 }
5568
5569 /* Delivery can be restricted only to those recipients (if any) that the
5570 filter specified. */
5571
5572 else if (rc == FF_DELIVERED)
5573 {
5574 process_recipients = RECIP_IGNORE;
5575 if (addr_new)
5576 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5577 else
5578 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5579 }
5580
5581 /* If any new addresses were created by the filter, fake up a "parent"
5582 for them. This is necessary for pipes, etc., which are expected to have
5583 parents, and it also gives some sensible logging for others. Allow
5584 pipes, files, and autoreplies, and run them as the filter uid if set,
5585 otherwise as the current uid. */
5586
5587 if (addr_new)
5588 {
5589 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5590 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5591
5592 /* The text "system-filter" is tested in transport_set_up_command() and in
5593 set_up_shell_command() in the pipe transport, to enable them to permit
5594 $recipients, so don't change it here without also changing it there. */
5595
5596 address_item *p = addr_new;
5597 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5598
5599 parent->domain = string_copylc(qualify_domain_recipient);
5600 parent->local_part = US"system-filter";
5601
5602 /* As part of this loop, we arrange for addr_last to end up pointing
5603 at the final address. This is used if we go on to add addresses for the
5604 original recipients. */
5605
5606 while (p)
5607 {
5608 if (parent->child_count == SHRT_MAX)
5609 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5610 "than %d delivery addresses", SHRT_MAX);
5611 parent->child_count++;
5612 p->parent = parent;
5613
5614 if (testflag(p, af_pfr))
5615 {
5616 uschar *tpname;
5617 uschar *type;
5618 p->uid = uid;
5619 p->gid = gid;
5620 setflag(p, af_uid_set |
5621 af_gid_set |
5622 af_allow_file |
5623 af_allow_pipe |
5624 af_allow_reply);
5625
5626 /* Find the name of the system filter's appropriate pfr transport */
5627
5628 if (p->address[0] == '|')
5629 {
5630 type = US"pipe";
5631 tpname = system_filter_pipe_transport;
5632 address_pipe = p->address;
5633 }
5634 else if (p->address[0] == '>')
5635 {
5636 type = US"reply";
5637 tpname = system_filter_reply_transport;
5638 }
5639 else
5640 {
5641 if (p->address[Ustrlen(p->address)-1] == '/')
5642 {
5643 type = US"directory";
5644 tpname = system_filter_directory_transport;
5645 }
5646 else
5647 {
5648 type = US"file";
5649 tpname = system_filter_file_transport;
5650 }
5651 address_file = p->address;
5652 }
5653
5654 /* Now find the actual transport, first expanding the name. We have
5655 set address_file or address_pipe above. */
5656
5657 if (tpname)
5658 {
5659 uschar *tmp = expand_string(tpname);
5660 address_file = address_pipe = NULL;
5661 if (!tmp)
5662 p->message = string_sprintf("failed to expand \"%s\" as a "
5663 "system filter transport name", tpname);
5664 tpname = tmp;
5665 }
5666 else
5667 {
5668 p->message = string_sprintf("system_filter_%s_transport is unset",
5669 type);
5670 }
5671
5672 if (tpname)
5673 {
5674 transport_instance *tp;
5675 for (tp = transports; tp; tp = tp->next)
5676 {
5677 if (Ustrcmp(tp->name, tpname) == 0)
5678 {
5679 p->transport = tp;
5680 break;
5681 }
5682 }
5683 if (!tp)
5684 p->message = string_sprintf("failed to find \"%s\" transport "
5685 "for system filter delivery", tpname);
5686 }
5687
5688 /* If we couldn't set up a transport, defer the delivery, putting the
5689 error on the panic log as well as the main log. */
5690
5691 if (!p->transport)
5692 {
5693 address_item *badp = p;
5694 p = p->next;
5695 if (!addr_last) addr_new = p; else addr_last->next = p;
5696 badp->local_part = badp->address; /* Needed for log line */
5697 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5698 continue;
5699 }
5700 } /* End of pfr handling */
5701
5702 /* Either a non-pfr delivery, or we found a transport */
5703
5704 DEBUG(D_deliver|D_filter)
5705 debug_printf("system filter added %s\n", p->address);
5706
5707 addr_last = p;
5708 p = p->next;
5709 } /* Loop through all addr_new addresses */
5710 }
5711 }
5712
5713
5714/* Scan the recipients list, and for every one that is not in the non-
5715recipients tree, add an addr item to the chain of new addresses. If the pno
5716value is non-negative, we must set the onetime parent from it. This which
5717points to the relevant entry in the recipients list.
5718
5719This processing can be altered by the setting of the process_recipients
5720variable, which is changed if recipients are to be ignored, failed, or
5721deferred. This can happen as a result of system filter activity, or if the -Mg
5722option is used to fail all of them.
5723
5724Duplicate addresses are handled later by a different tree structure; we can't
5725just extend the non-recipients tree, because that will be re-written to the
5726spool if the message is deferred, and in any case there are casing
5727complications for local addresses. */
5728
5729if (process_recipients != RECIP_IGNORE)
5730 {
5731 for (i = 0; i < recipients_count; i++)
5732 {
5733 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
5734 {
5735 recipient_item *r = recipients_list + i;
5736 address_item *new = deliver_make_addr(r->address, FALSE);
5737 new->prop.errors_address = r->errors_to;
5738#ifdef EXPERIMENTAL_INTERNATIONAL
5739 if ((new->prop.utf8_msg = message_smtputf8))
5740 {
5741 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
5742 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
5743 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
5744 new->prop.utf8_downcvt ? "yes"
5745 : new->prop.utf8_downcvt_maybe ? "ifneeded"
5746 : "no");
5747 }
5748#endif
5749
5750 if (r->pno >= 0)
5751 new->onetime_parent = recipients_list[r->pno].address;
5752
5753 /* If DSN support is enabled, set the dsn flags and the original receipt
5754 to be passed on to other DSN enabled MTAs */
5755 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5756 new->dsn_orcpt = r->orcpt;
5757 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
5758 new->dsn_orcpt, new->dsn_flags);
5759
5760 switch (process_recipients)
5761 {
5762 /* RECIP_DEFER is set when a system filter freezes a message. */
5763
5764 case RECIP_DEFER:
5765 new->next = addr_defer;
5766 addr_defer = new;
5767 break;
5768
5769
5770 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5771 command. */
5772
5773 case RECIP_FAIL_FILTER:
5774 new->message =
5775 filter_message ? filter_message : US"delivery cancelled";
5776 setflag(new, af_pass_message);
5777 goto RECIP_QUEUE_FAILED; /* below */
5778
5779
5780 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5781 than the value in timeout_frozen_after. Treat non-bounce messages
5782 similarly to -Mg; for bounce messages we just want to discard, so
5783 don't put the address on the failed list. The timeout has already
5784 been logged. */
5785
5786 case RECIP_FAIL_TIMEOUT:
5787 new->message = US"delivery cancelled; message timed out";
5788 goto RECIP_QUEUE_FAILED; /* below */
5789
5790
5791 /* RECIP_FAIL is set when -Mg has been used. */
5792
5793 case RECIP_FAIL:
5794 new->message = US"delivery cancelled by administrator";
5795 /* Fall through */
5796
5797 /* Common code for the failure cases above. If this is not a bounce
5798 message, put the address on the failed list so that it is used to
5799 create a bounce. Otherwise do nothing - this just discards the address.
5800 The incident has already been logged. */
5801
5802 RECIP_QUEUE_FAILED:
5803 if (sender_address[0] != 0)
5804 {
5805 new->next = addr_failed;
5806 addr_failed = new;
5807 }
5808 break;
5809
5810
5811 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5812 in the message. Process each address as a routing failure; if this
5813 is a bounce message, it will get frozen. */
5814
5815 case RECIP_FAIL_LOOP:
5816 new->message = US"Too many \"Received\" headers - suspected mail loop";
5817 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5818 break;
5819
5820
5821 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5822
5823 default:
5824 if (!addr_new) addr_new = new; else addr_last->next = new;
5825 addr_last = new;
5826 break;
5827 }
5828
5829#ifdef EXPERIMENTAL_EVENT
5830 if (process_recipients != RECIP_ACCEPT)
5831 {
5832 uschar * save_local = deliver_localpart;
5833 const uschar * save_domain = deliver_domain;
5834
5835 deliver_localpart = expand_string(
5836 string_sprintf("${local_part:%s}", new->address));
5837 deliver_domain = expand_string(
5838 string_sprintf("${domain:%s}", new->address));
5839
5840 (void) event_raise(event_action,
5841 US"msg:fail:internal", new->message);
5842
5843 deliver_localpart = save_local;
5844 deliver_domain = save_domain;
5845 }
5846#endif
5847 }
5848 }
5849 }
5850
5851DEBUG(D_deliver)
5852 {
5853 address_item *p;
5854 debug_printf("Delivery address list:\n");
5855 for (p = addr_new; p; p = p->next)
5856 debug_printf(" %s %s\n", p->address,
5857 p->onetime_parent ? p->onetime_parent : US"");
5858 }
5859
5860/* Set up the buffers used for copying over the file when delivering. */
5861
5862deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5863deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5864
5865
5866
5867/* Until there are no more new addresses, handle each one as follows:
5868
5869 . If this is a generated address (indicated by the presence of a parent
5870 pointer) then check to see whether it is a pipe, file, or autoreply, and
5871 if so, handle it directly here. The router that produced the address will
5872 have set the allow flags into the address, and also set the uid/gid required.
5873 Having the routers generate new addresses and then checking them here at
5874 the outer level is tidier than making each router do the checking, and
5875 means that routers don't need access to the failed address queue.
5876
5877 . Break up the address into local part and domain, and make lowercased
5878 versions of these strings. We also make unquoted versions of the local part.
5879
5880 . Handle the percent hack for those domains for which it is valid.
5881
5882 . For child addresses, determine if any of the parents have the same address.
5883 If so, generate a different string for previous delivery checking. Without
5884 this code, if the address spqr generates spqr via a forward or alias file,
5885 delivery of the generated spqr stops further attempts at the top level spqr,
5886 which is not what is wanted - it may have generated other addresses.
5887
5888 . Check on the retry database to see if routing was previously deferred, but
5889 only if in a queue run. Addresses that are to be routed are put on the
5890 addr_route chain. Addresses that are to be deferred are put on the
5891 addr_defer chain. We do all the checking first, so as not to keep the
5892 retry database open any longer than necessary.
5893
5894 . Now we run the addresses through the routers. A router may put the address
5895 on either the addr_local or the addr_remote chain for local or remote
5896 delivery, respectively, or put it on the addr_failed chain if it is
5897 undeliveable, or it may generate child addresses and put them on the
5898 addr_new chain, or it may defer an address. All the chain anchors are
5899 passed as arguments so that the routers can be called for verification
5900 purposes as well.
5901
5902 . If new addresses have been generated by the routers, da capo.
5903*/
5904
5905header_rewritten = FALSE; /* No headers rewritten yet */
5906while (addr_new) /* Loop until all addresses dealt with */
5907 {
5908 address_item *addr, *parent;
5909
5910 /* Failure to open the retry database is treated the same as if it does
5911 not exist. In both cases, dbm_file is NULL. */
5912
5913 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
5914 {
5915 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5916 debug_printf("no retry data available\n");
5917 }
5918
5919 /* Scan the current batch of new addresses, to handle pipes, files and
5920 autoreplies, and determine which others are ready for routing. */
5921
5922 while (addr_new)
5923 {
5924 int rc;
5925 uschar *p;
5926 tree_node *tnode;
5927 dbdata_retry *domain_retry_record;
5928 dbdata_retry *address_retry_record;
5929
5930 addr = addr_new;
5931 addr_new = addr->next;
5932
5933 DEBUG(D_deliver|D_retry|D_route)
5934 {
5935 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5936 debug_printf("Considering: %s\n", addr->address);
5937 }
5938
5939 /* Handle generated address that is a pipe or a file or an autoreply. */
5940
5941 if (testflag(addr, af_pfr))
5942 {
5943 /* If an autoreply in a filter could not generate a syntactically valid
5944 address, give up forthwith. Set af_ignore_error so that we don't try to
5945 generate a bounce. */
5946
5947 if (testflag(addr, af_bad_reply))
5948 {
5949 addr->basic_errno = ERRNO_BADADDRESS2;
5950 addr->local_part = addr->address;
5951 addr->message =
5952 US"filter autoreply generated syntactically invalid recipient";
5953 setflag(addr, af_ignore_error);
5954 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5955 continue; /* with the next new address */
5956 }
5957
5958 /* If two different users specify delivery to the same pipe or file or
5959 autoreply, there should be two different deliveries, so build a unique
5960 string that incorporates the original address, and use this for
5961 duplicate testing and recording delivery, and also for retrying. */
5962
5963 addr->unique =
5964 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5965 (testflag(addr->parent, af_homonym)? 3:0));
5966
5967 addr->address_retry_key = addr->domain_retry_key =
5968 string_sprintf("T:%s", addr->unique);
5969
5970 /* If a filter file specifies two deliveries to the same pipe or file,
5971 we want to de-duplicate, but this is probably not wanted for two mail
5972 commands to the same address, where probably both should be delivered.
5973 So, we have to invent a different unique string in that case. Just
5974 keep piling '>' characters on the front. */
5975
5976 if (addr->address[0] == '>')
5977 {
5978 while (tree_search(tree_duplicates, addr->unique))
5979 addr->unique = string_sprintf(">%s", addr->unique);
5980 }
5981
5982 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5983 {
5984 DEBUG(D_deliver|D_route)
5985 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5986 addr->dupof = tnode->data.ptr;
5987 addr->next = addr_duplicate;
5988 addr_duplicate = addr;
5989 continue;
5990 }
5991
5992 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5993
5994 /* Check for previous delivery */
5995
5996 if (tree_search(tree_nonrecipients, addr->unique))
5997 {
5998 DEBUG(D_deliver|D_route)
5999 debug_printf("%s was previously delivered: discarded\n", addr->address);
6000 child_done(addr, tod_stamp(tod_log));
6001 continue;
6002 }
6003
6004 /* Save for checking future duplicates */
6005
6006 tree_add_duplicate(addr->unique, addr);
6007
6008 /* Set local part and domain */
6009
6010 addr->local_part = addr->address;
6011 addr->domain = addr->parent->domain;
6012
6013 /* Ensure that the delivery is permitted. */
6014
6015 if (testflag(addr, af_file))
6016 {
6017 if (!testflag(addr, af_allow_file))
6018 {
6019 addr->basic_errno = ERRNO_FORBIDFILE;
6020 addr->message = US"delivery to file forbidden";
6021 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6022 continue; /* with the next new address */
6023 }
6024 }
6025 else if (addr->address[0] == '|')
6026 {
6027 if (!testflag(addr, af_allow_pipe))
6028 {
6029 addr->basic_errno = ERRNO_FORBIDPIPE;
6030 addr->message = US"delivery to pipe forbidden";
6031 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6032 continue; /* with the next new address */
6033 }
6034 }
6035 else if (!testflag(addr, af_allow_reply))
6036 {
6037 addr->basic_errno = ERRNO_FORBIDREPLY;
6038 addr->message = US"autoreply forbidden";
6039 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6040 continue; /* with the next new address */
6041 }
6042
6043 /* If the errno field is already set to BADTRANSPORT, it indicates
6044 failure to expand a transport string, or find the associated transport,
6045 or an unset transport when one is required. Leave this test till now so
6046 that the forbid errors are given in preference. */
6047
6048 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6049 {
6050 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6051 continue;
6052 }
6053
6054 /* Treat /dev/null as a special case and abandon the delivery. This
6055 avoids having to specify a uid on the transport just for this case.
6056 Arrange for the transport name to be logged as "**bypassed**". */
6057
6058 if (Ustrcmp(addr->address, "/dev/null") == 0)
6059 {
6060 uschar *save = addr->transport->name;
6061 addr->transport->name = US"**bypassed**";
6062 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
6063 addr->transport->name = save;
6064 continue; /* with the next new address */
6065 }
6066
6067 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6068 delivery. */
6069
6070 DEBUG(D_deliver|D_route)
6071 debug_printf("queued for %s transport\n", addr->transport->name);
6072 addr->next = addr_local;
6073 addr_local = addr;
6074 continue; /* with the next new address */
6075 }
6076
6077 /* Handle normal addresses. First, split up into local part and domain,
6078 handling the %-hack if necessary. There is the possibility of a defer from
6079 a lookup in percent_hack_domains. */
6080
6081 if ((rc = deliver_split_address(addr)) == DEFER)
6082 {
6083 addr->message = US"cannot check percent_hack_domains";
6084 addr->basic_errno = ERRNO_LISTDEFER;
6085 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6086 continue;
6087 }
6088
6089 /* Check to see if the domain is held. If so, proceed only if the
6090 delivery was forced by hand. */
6091
6092 deliver_domain = addr->domain; /* set $domain */
6093 if ( !forced && hold_domains
6094 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6095 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6096 NULL)) != FAIL
6097 )
6098 {
6099 if (rc == DEFER)
6100 {
6101 addr->message = US"hold_domains lookup deferred";
6102 addr->basic_errno = ERRNO_LISTDEFER;
6103 }
6104 else
6105 {
6106 addr->message = US"domain is held";
6107 addr->basic_errno = ERRNO_HELD;
6108 }
6109 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6110 continue;
6111 }
6112
6113 /* Now we can check for duplicates and previously delivered addresses. In
6114 order to do this, we have to generate a "unique" value for each address,
6115 because there may be identical actual addresses in a line of descendents.
6116 The "unique" field is initialized to the same value as the "address" field,
6117 but gets changed here to cope with identically-named descendents. */
6118
6119 for (parent = addr->parent; parent; parent = parent->parent)
6120 if (strcmpic(addr->address, parent->address) == 0) break;
6121
6122 /* If there's an ancestor with the same name, set the homonym flag. This
6123 influences how deliveries are recorded. Then add a prefix on the front of
6124 the unique address. We use \n\ where n starts at 0 and increases each time.
6125 It is unlikely to pass 9, but if it does, it may look odd but will still
6126 work. This means that siblings or cousins with the same names are treated
6127 as duplicates, which is what we want. */
6128
6129 if (parent)
6130 {
6131 setflag(addr, af_homonym);
6132 if (parent->unique[0] != '\\')
6133 addr->unique = string_sprintf("\\0\\%s", addr->address);
6134 else
6135 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6136 addr->address);
6137 }
6138
6139 /* Ensure that the domain in the unique field is lower cased, because
6140 domains are always handled caselessly. */
6141
6142 p = Ustrrchr(addr->unique, '@');
6143 while (*p != 0) { *p = tolower(*p); p++; }
6144
6145 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6146
6147 if (tree_search(tree_nonrecipients, addr->unique))
6148 {
6149 DEBUG(D_deliver|D_route)
6150 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6151 child_done(addr, tod_stamp(tod_log));
6152 continue;
6153 }
6154
6155 /* Get the routing retry status, saving the two retry keys (with and
6156 without the local part) for subsequent use. If there is no retry record for
6157 the standard address routing retry key, we look for the same key with the
6158 sender attached, because this form is used by the smtp transport after a
6159 4xx response to RCPT when address_retry_include_sender is true. */
6160
6161 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6162 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6163 addr->domain);
6164
6165 if (dbm_file)
6166 {
6167 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6168 if ( domain_retry_record
6169 && now - domain_retry_record->time_stamp > retry_data_expire
6170 )
6171 domain_retry_record = NULL; /* Ignore if too old */
6172
6173 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6174 if ( address_retry_record
6175 && now - address_retry_record->time_stamp > retry_data_expire
6176 )
6177 address_retry_record = NULL; /* Ignore if too old */
6178
6179 if (!address_retry_record)
6180 {
6181 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6182 sender_address);
6183 address_retry_record = dbfn_read(dbm_file, altkey);
6184 if ( address_retry_record
6185 && now - address_retry_record->time_stamp > retry_data_expire)
6186 address_retry_record = NULL; /* Ignore if too old */
6187 }
6188 }
6189 else
6190 domain_retry_record = address_retry_record = NULL;
6191
6192 DEBUG(D_deliver|D_retry)
6193 {
6194 if (!domain_retry_record)
6195 debug_printf("no domain retry record\n");
6196 if (!address_retry_record)
6197 debug_printf("no address retry record\n");
6198 }
6199
6200 /* If we are sending a message down an existing SMTP connection, we must
6201 assume that the message which created the connection managed to route
6202 an address to that connection. We do not want to run the risk of taking
6203 a long time over routing here, because if we do, the server at the other
6204 end of the connection may time it out. This is especially true for messages
6205 with lots of addresses. For this kind of delivery, queue_running is not
6206 set, so we would normally route all addresses. We take a pragmatic approach
6207 and defer routing any addresses that have any kind of domain retry record.
6208 That is, we don't even look at their retry times. It doesn't matter if this
6209 doesn't work occasionally. This is all just an optimization, after all.
6210
6211 The reason for not doing the same for address retries is that they normally
6212 arise from 4xx responses, not DNS timeouts. */
6213
6214 if (continue_hostname && domain_retry_record)
6215 {
6216 addr->message = US"reusing SMTP connection skips previous routing defer";
6217 addr->basic_errno = ERRNO_RRETRY;
6218 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6219 }
6220
6221 /* If we are in a queue run, defer routing unless there is no retry data or
6222 we've passed the next retry time, or this message is forced. In other
6223 words, ignore retry data when not in a queue run.
6224
6225 However, if the domain retry time has expired, always allow the routing
6226 attempt. If it fails again, the address will be failed. This ensures that
6227 each address is routed at least once, even after long-term routing
6228 failures.
6229
6230 If there is an address retry, check that too; just wait for the next
6231 retry time. This helps with the case when the temporary error on the
6232 address was really message-specific rather than address specific, since
6233 it allows other messages through.
6234
6235 We also wait for the next retry time if this is a message sent down an
6236 existing SMTP connection (even though that will be forced). Otherwise there
6237 will be far too many attempts for an address that gets a 4xx error. In
6238 fact, after such an error, we should not get here because, the host should
6239 not be remembered as one this message needs. However, there was a bug that
6240 used to cause this to happen, so it is best to be on the safe side.
6241
6242 Even if we haven't reached the retry time in the hints, there is one more
6243 check to do, which is for the ultimate address timeout. We only do this
6244 check if there is an address retry record and there is not a domain retry
6245 record; this implies that previous attempts to handle the address had the
6246 retry_use_local_parts option turned on. We use this as an approximation
6247 for the destination being like a local delivery, for example delivery over
6248 LMTP to an IMAP message store. In this situation users are liable to bump
6249 into their quota and thereby have intermittently successful deliveries,
6250 which keep the retry record fresh, which can lead to us perpetually
6251 deferring messages. */
6252
6253 else if ( ( queue_running && !deliver_force
6254 || continue_hostname
6255 )
6256 && ( ( domain_retry_record
6257 && now < domain_retry_record->next_try
6258 && !domain_retry_record->expired
6259 )
6260 || ( address_retry_record
6261 && now < address_retry_record->next_try
6262 ) )
6263 && ( domain_retry_record
6264 || !address_retry_record
6265 || !retry_ultimate_address_timeout(addr->address_retry_key,
6266 addr->domain, address_retry_record, now)
6267 ) )
6268 {
6269 addr->message = US"retry time not reached";
6270 addr->basic_errno = ERRNO_RRETRY;
6271 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6272 }
6273
6274 /* The domain is OK for routing. Remember if retry data exists so it
6275 can be cleaned up after a successful delivery. */
6276
6277 else
6278 {
6279 if (domain_retry_record || address_retry_record)
6280 setflag(addr, af_dr_retry_exists);
6281 addr->next = addr_route;
6282 addr_route = addr;
6283 DEBUG(D_deliver|D_route)
6284 debug_printf("%s: queued for routing\n", addr->address);
6285 }
6286 }
6287
6288 /* The database is closed while routing is actually happening. Requests to
6289 update it are put on a chain and all processed together at the end. */
6290
6291 if (dbm_file) dbfn_close(dbm_file);
6292
6293 /* If queue_domains is set, we don't even want to try routing addresses in
6294 those domains. During queue runs, queue_domains is forced to be unset.
6295 Optimize by skipping this pass through the addresses if nothing is set. */
6296
6297 if (!deliver_force && queue_domains)
6298 {
6299 address_item *okaddr = NULL;
6300 while (addr_route)
6301 {
6302 address_item *addr = addr_route;
6303 addr_route = addr->next;
6304
6305 deliver_domain = addr->domain; /* set $domain */
6306 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6307 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6308 != OK)
6309 {
6310 if (rc == DEFER)
6311 {
6312 addr->basic_errno = ERRNO_LISTDEFER;
6313 addr->message = US"queue_domains lookup deferred";
6314 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6315 }
6316 else
6317 {
6318 addr->next = okaddr;
6319 okaddr = addr;
6320 }
6321 }
6322 else
6323 {
6324 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6325 addr->message = US"domain is in queue_domains";
6326 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6327 }
6328 }
6329
6330 addr_route = okaddr;
6331 }
6332
6333 /* Now route those addresses that are not deferred. */
6334
6335 while (addr_route)
6336 {
6337 int rc;
6338 address_item *addr = addr_route;
6339 const uschar *old_domain = addr->domain;
6340 uschar *old_unique = addr->unique;
6341 addr_route = addr->next;
6342 addr->next = NULL;
6343
6344 /* Just in case some router parameter refers to it. */
6345
6346 if (!(return_path = addr->prop.errors_address))
6347 return_path = sender_address;
6348
6349 /* If a router defers an address, add a retry item. Whether or not to
6350 use the local part in the key is a property of the router. */
6351
6352 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6353 &addr_succeed, v_none)) == DEFER)
6354 retry_add_item(addr,
6355 addr->router->retry_use_local_part
6356 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6357 : string_sprintf("R:%s", addr->domain),
6358 0);
6359
6360 /* Otherwise, if there is an existing retry record in the database, add
6361 retry items to delete both forms. We must also allow for the possibility
6362 of a routing retry that includes the sender address. Since the domain might
6363 have been rewritten (expanded to fully qualified) as a result of routing,
6364 ensure that the rewritten form is also deleted. */
6365
6366 else if (testflag(addr, af_dr_retry_exists))
6367 {
6368 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6369 sender_address);
6370 retry_add_item(addr, altkey, rf_delete);
6371 retry_add_item(addr, addr->address_retry_key, rf_delete);
6372 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6373 if (Ustrcmp(addr->domain, old_domain) != 0)
6374 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6375 }
6376
6377 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6378 logged, but we need to ensure the address (and maybe parents) is marked
6379 done. */
6380
6381 if (rc == DISCARD)
6382 {
6383 address_done(addr, tod_stamp(tod_log));
6384 continue; /* route next address */
6385 }
6386
6387 /* The address is finished with (failed or deferred). */
6388
6389 if (rc != OK)
6390 {
6391 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6392 continue; /* route next address */
6393 }
6394
6395 /* The address has been routed. If the router changed the domain, it will
6396 also have changed the unique address. We have to test whether this address
6397 has already been delivered, because it's the unique address that finally
6398 gets recorded. */
6399
6400 if ( addr->unique != old_unique
6401 && tree_search(tree_nonrecipients, addr->unique) != 0
6402 )
6403 {
6404 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6405 "discarded\n", addr->address);
6406 if (addr_remote == addr) addr_remote = addr->next;
6407 else if (addr_local == addr) addr_local = addr->next;
6408 }
6409
6410 /* If the router has same_domain_copy_routing set, we are permitted to copy
6411 the routing for any other addresses with the same domain. This is an
6412 optimisation to save repeated DNS lookups for "standard" remote domain
6413 routing. The option is settable only on routers that generate host lists.
6414 We play it very safe, and do the optimization only if the address is routed
6415 to a remote transport, there are no header changes, and the domain was not
6416 modified by the router. */
6417
6418 if ( addr_remote == addr
6419 && addr->router->same_domain_copy_routing
6420 && !addr->prop.extra_headers
6421 && !addr->prop.remove_headers
6422 && old_domain == addr->domain
6423 )
6424 {
6425 address_item **chain = &addr_route;
6426 while (*chain)
6427 {
6428 address_item *addr2 = *chain;
6429 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6430 {
6431 chain = &(addr2->next);
6432 continue;
6433 }
6434
6435 /* Found a suitable address; take it off the routing list and add it to
6436 the remote delivery list. */
6437
6438 *chain = addr2->next;
6439 addr2->next = addr_remote;
6440 addr_remote = addr2;
6441
6442 /* Copy the routing data */
6443
6444 addr2->domain = addr->domain;
6445 addr2->router = addr->router;
6446 addr2->transport = addr->transport;
6447 addr2->host_list = addr->host_list;
6448 addr2->fallback_hosts = addr->fallback_hosts;
6449 addr2->prop.errors_address = addr->prop.errors_address;
6450 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6451
6452 DEBUG(D_deliver|D_route)
6453 {
6454 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6455 "routing %s\n"
6456 "Routing for %s copied from %s\n",
6457 addr2->address, addr2->address, addr->address);
6458 }
6459 }
6460 }
6461 } /* Continue with routing the next address. */
6462 } /* Loop to process any child addresses that the routers created, and
6463 any rerouted addresses that got put back on the new chain. */
6464
6465
6466/* Debugging: show the results of the routing */
6467
6468DEBUG(D_deliver|D_retry|D_route)
6469 {
6470 address_item *p;
6471 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6472 debug_printf("After routing:\n Local deliveries:\n");
6473 for (p = addr_local; p; p = p->next)
6474 debug_printf(" %s\n", p->address);
6475
6476 debug_printf(" Remote deliveries:\n");
6477 for (p = addr_remote; p; p = p->next)
6478 debug_printf(" %s\n", p->address);
6479
6480 debug_printf(" Failed addresses:\n");
6481 for (p = addr_failed; p; p = p->next)
6482 debug_printf(" %s\n", p->address);
6483
6484 debug_printf(" Deferred addresses:\n");
6485 for (p = addr_defer; p; p = p->next)
6486 debug_printf(" %s\n", p->address);
6487 }
6488
6489/* Free any resources that were cached during routing. */
6490
6491search_tidyup();
6492route_tidyup();
6493
6494/* These two variables are set only during routing, after check_local_user.
6495Ensure they are not set in transports. */
6496
6497local_user_gid = (gid_t)(-1);
6498local_user_uid = (uid_t)(-1);
6499
6500/* Check for any duplicate addresses. This check is delayed until after
6501routing, because the flexibility of the routing configuration means that
6502identical addresses with different parentage may end up being redirected to
6503different addresses. Checking for duplicates too early (as we previously used
6504to) makes this kind of thing not work. */
6505
6506do_duplicate_check(&addr_local);
6507do_duplicate_check(&addr_remote);
6508
6509/* When acting as an MUA wrapper, we proceed only if all addresses route to a
6510remote transport. The check that they all end up in one transaction happens in
6511the do_remote_deliveries() function. */
6512
6513if ( mua_wrapper
6514 && (addr_local || addr_failed || addr_defer)
6515 )
6516 {
6517 address_item *addr;
6518 uschar *which, *colon, *msg;
6519
6520 if (addr_local)
6521 {
6522 addr = addr_local;
6523 which = US"local";
6524 }
6525 else if (addr_defer)
6526 {
6527 addr = addr_defer;
6528 which = US"deferred";
6529 }
6530 else
6531 {
6532 addr = addr_failed;
6533 which = US"failed";
6534 }
6535
6536 while (addr->parent) addr = addr->parent;
6537
6538 if (addr->message)
6539 {
6540 colon = US": ";
6541 msg = addr->message;
6542 }
6543 else colon = msg = US"";
6544
6545 /* We don't need to log here for a forced failure as it will already
6546 have been logged. Defer will also have been logged, but as a defer, so we do
6547 need to do the failure logging. */
6548
6549 if (addr != addr_failed)
6550 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6551 addr->address, which);
6552
6553 /* Always write an error to the caller */
6554
6555 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6556 which, colon, msg);
6557
6558 final_yield = DELIVER_MUA_FAILED;
6559 addr_failed = addr_defer = NULL; /* So that we remove the message */
6560 goto DELIVERY_TIDYUP;
6561 }
6562
6563
6564/* If this is a run to continue deliveries to an external channel that is
6565already set up, defer any local deliveries. */
6566
6567if (continue_transport)
6568 {
6569 if (addr_defer)
6570 {
6571 address_item *addr = addr_defer;
6572 while (addr->next) addr = addr->next;
6573 addr->next = addr_local;
6574 }
6575 else
6576 addr_defer = addr_local;
6577 addr_local = NULL;
6578 }
6579
6580
6581/* Because address rewriting can happen in the routers, we should not really do
6582ANY deliveries until all addresses have been routed, so that all recipients of
6583the message get the same headers. However, this is in practice not always
6584possible, since sometimes remote addresses give DNS timeouts for days on end.
6585The pragmatic approach is to deliver what we can now, saving any rewritten
6586headers so that at least the next lot of recipients benefit from the rewriting
6587that has already been done.
6588
6589If any headers have been rewritten during routing, update the spool file to
6590remember them for all subsequent deliveries. This can be delayed till later if
6591there is only address to be delivered - if it succeeds the spool write need not
6592happen. */
6593
6594if ( header_rewritten
6595 && ( ( addr_local
6596 && (addr_local->next || addr_remote)
6597 )
6598 || (addr_remote && addr_remote->next)
6599 ) )
6600 {
6601 /* Panic-dies on error */
6602 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6603 header_rewritten = FALSE;
6604 }
6605
6606
6607/* If there are any deliveries to be done, open the journal file. This is used
6608to record successful deliveries as soon as possible after each delivery is
6609known to be complete. A file opened with O_APPEND is used so that several
6610processes can run simultaneously.
6611
6612The journal is just insurance against crashes. When the spool file is
6613ultimately updated at the end of processing, the journal is deleted. If a
6614journal is found to exist at the start of delivery, the addresses listed
6615therein are added to the non-recipients. */
6616
6617if (addr_local || addr_remote)
6618 {
6619 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6620 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6621
6622 if (journal_fd < 0)
6623 {
6624 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6625 spoolname, strerror(errno));
6626 return DELIVER_NOT_ATTEMPTED;
6627 }
6628
6629 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6630 that the mode is correct - the group setting doesn't always seem to get
6631 set automatically. */
6632
6633 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6634 || fchown(journal_fd, exim_uid, exim_gid)
6635 || fchmod(journal_fd, SPOOL_MODE)
6636 )
6637 {
6638 int ret = Uunlink(spoolname);
6639 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6640 spoolname, strerror(errno));
6641 if(ret && errno != ENOENT)
6642 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6643 spoolname, strerror(errno));
6644 return DELIVER_NOT_ATTEMPTED;
6645 }
6646 }
6647
6648
6649
6650/* Now we can get down to the business of actually doing deliveries. Local
6651deliveries are done first, then remote ones. If ever the problems of how to
6652handle fallback transports are figured out, this section can be put into a loop
6653for handling fallbacks, though the uid switching will have to be revised. */
6654
6655/* Precompile a regex that is used to recognize a parameter in response
6656to an LHLO command, if is isn't already compiled. This may be used on both
6657local and remote LMTP deliveries. */
6658
6659if (!regex_IGNOREQUOTA)
6660 regex_IGNOREQUOTA =
6661 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6662
6663/* Handle local deliveries */
6664
6665if (addr_local)
6666 {
6667 DEBUG(D_deliver|D_transport)
6668 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6669 do_local_deliveries();
6670 disable_logging = FALSE;
6671 }
6672
6673/* If queue_run_local is set, we do not want to attempt any remote deliveries,
6674so just queue them all. */
6675
6676if (queue_run_local)
6677 {
6678 while (addr_remote)
6679 {
6680 address_item *addr = addr_remote;
6681 addr_remote = addr->next;
6682 addr->next = NULL;
6683 addr->basic_errno = ERRNO_LOCAL_ONLY;
6684 addr->message = US"remote deliveries suppressed";
6685 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6686 }
6687 }
6688
6689/* Handle remote deliveries */
6690
6691if (addr_remote)
6692 {
6693 DEBUG(D_deliver|D_transport)
6694 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6695
6696 /* Precompile some regex that are used to recognize parameters in response
6697 to an EHLO command, if they aren't already compiled. */
6698
6699 deliver_init();
6700
6701 /* Now sort the addresses if required, and do the deliveries. The yield of
6702 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6703 cannot be delivered in one transaction. */
6704
6705 if (remote_sort_domains) sort_remote_deliveries();
6706 if (!do_remote_deliveries(FALSE))
6707 {
6708 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6709 "be delivered in one transaction");
6710 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6711
6712 final_yield = DELIVER_MUA_FAILED;
6713 addr_failed = addr_defer = NULL; /* So that we remove the message */
6714 goto DELIVERY_TIDYUP;
6715 }
6716
6717 /* See if any of the addresses that failed got put on the queue for delivery
6718 to their fallback hosts. We do it this way because often the same fallback
6719 host is used for many domains, so all can be sent in a single transaction
6720 (if appropriately configured). */
6721
6722 if (addr_fallback && !mua_wrapper)
6723 {
6724 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6725 addr_remote = addr_fallback;
6726 addr_fallback = NULL;
6727 if (remote_sort_domains) sort_remote_deliveries();
6728 do_remote_deliveries(TRUE);
6729 }
6730 disable_logging = FALSE;
6731 }
6732
6733
6734/* All deliveries are now complete. Ignore SIGTERM during this tidying up
6735phase, to minimize cases of half-done things. */
6736
6737DEBUG(D_deliver)
6738 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6739
6740/* Root privilege is no longer needed */
6741
6742exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6743
6744set_process_info("tidying up after delivering %s", message_id);
6745signal(SIGTERM, SIG_IGN);
6746
6747/* When we are acting as an MUA wrapper, the smtp transport will either have
6748succeeded for all addresses, or failed them all in normal cases. However, there
6749are some setup situations (e.g. when a named port does not exist) that cause an
6750immediate exit with deferral of all addresses. Convert those into failures. We
6751do not ever want to retry, nor do we want to send a bounce message. */
6752
6753if (mua_wrapper)
6754 {
6755 if (addr_defer)
6756 {
6757 address_item *addr, *nextaddr;
6758 for (addr = addr_defer; addr; addr = nextaddr)
6759 {
6760 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6761 "delivery", addr->address);
6762 nextaddr = addr->next;
6763 addr->next = addr_failed;
6764 addr_failed = addr;
6765 }
6766 addr_defer = NULL;
6767 }
6768
6769 /* Now all should either have succeeded or failed. */
6770
6771 if (!addr_failed)
6772 final_yield = DELIVER_MUA_SUCCEEDED;
6773 else
6774 {
6775 host_item * host;
6776 uschar *s = addr_failed->user_message;
6777
6778 if (!s) s = addr_failed->message;
6779
6780 fprintf(stderr, "Delivery failed: ");
6781 if (addr_failed->basic_errno > 0)
6782 {
6783 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6784 if (s) fprintf(stderr, ": ");
6785 }
6786 if ((host = addr_failed->host_used))
6787 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
6788 if (s)
6789 fprintf(stderr, "%s", CS s);
6790 else if (addr_failed->basic_errno <= 0)
6791 fprintf(stderr, "unknown error");
6792 fprintf(stderr, "\n");
6793
6794 final_yield = DELIVER_MUA_FAILED;
6795 addr_failed = NULL;
6796 }
6797 }
6798
6799/* In a normal configuration, we now update the retry database. This is done in
6800one fell swoop at the end in order not to keep opening and closing (and
6801locking) the database. The code for handling retries is hived off into a
6802separate module for convenience. We pass it the addresses of the various
6803chains, because deferred addresses can get moved onto the failed chain if the
6804retry cutoff time has expired for all alternative destinations. Bypass the
6805updating of the database if the -N flag is set, which is a debugging thing that
6806prevents actual delivery. */
6807
6808else if (!dont_deliver)
6809 retry_update(&addr_defer, &addr_failed, &addr_succeed);
6810
6811/* Send DSN for successful messages */
6812addr_dsntmp = addr_succeed;
6813addr_senddsn = NULL;
6814
6815while(addr_dsntmp)
6816 {
6817 /* af_ignore_error not honored here. it's not an error */
6818 DEBUG(D_deliver)
6819 {
6820 debug_printf("DSN: processing router : %s\n"
6821 "DSN: processing successful delivery address: %s\n"
6822 "DSN: Sender_address: %s\n"
6823 "DSN: orcpt: %s flags: %d\n"
6824 "DSN: envid: %s ret: %d\n"
6825 "DSN: Final recipient: %s\n"
6826 "DSN: Remote SMTP server supports DSN: %d\n",
6827 addr_dsntmp->router->name,
6828 addr_dsntmp->address,
6829 sender_address,
6830 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
6831 dsn_envid, dsn_ret,
6832 addr_dsntmp->address,
6833 addr_dsntmp->dsn_aware
6834 );
6835 }
6836
6837 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6838 and a report was requested */
6839 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
6840 || addr_dsntmp->dsn_flags & rf_dsnlasthop
6841 )
6842 && addr_dsntmp->dsn_flags & rf_dsnflags
6843 && addr_dsntmp->dsn_flags & rf_notify_success
6844 )
6845 {
6846 /* copy and relink address_item and send report with all of them at once later */
6847 address_item *addr_next;
6848 addr_next = addr_senddsn;
6849 addr_senddsn = store_get(sizeof(address_item));
6850 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6851 addr_senddsn->next = addr_next;
6852 }
6853 else
6854 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6855
6856 addr_dsntmp = addr_dsntmp->next;
6857 }
6858
6859if (addr_senddsn)
6860 {
6861 pid_t pid;
6862 int fd;
6863
6864 /* create exim process to send message */
6865 pid = child_open_exim(&fd);
6866
6867 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6868
6869 if (pid < 0) /* Creation of child failed */
6870 {
6871 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6872 "create child process to send failure message: %s", getpid(),
6873 getppid(), strerror(errno));
6874
6875 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6876 }
6877 else /* Creation of child succeeded */
6878 {
6879 FILE *f = fdopen(fd, "wb");
6880 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6881 int topt = topt_add_return_path | topt_no_body;
6882 uschar * bound;
6883
6884 DEBUG(D_deliver)
6885 debug_printf("sending error message to: %s\n", sender_address);
6886
6887 /* build unique id for MIME boundary */
6888 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6889 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6890
6891 if (errors_reply_to)
6892 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6893
6894 fprintf(f, "Auto-Submitted: auto-generated\n"
6895 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6896 "To: %s\n"
6897 "Subject: Delivery Status Notification\n"
6898 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6899 "MIME-Version: 1.0\n\n"
6900
6901 "--%s\n"
6902 "Content-type: text/plain; charset=us-ascii\n\n"
6903
6904 "This message was created automatically by mail delivery software.\n"
6905 " ----- The following addresses had successful delivery notifications -----\n",
6906 qualify_domain_sender, sender_address, bound, bound);
6907
6908 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
6909 addr_dsntmp = addr_dsntmp->next)
6910 fprintf(f, "<%s> (relayed %s)\n\n",
6911 addr_dsntmp->address,
6912 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6913 ? "via non DSN router"
6914 : addr_dsntmp->dsn_aware == dsn_support_no
6915 ? "to non-DSN-aware mailer"
6916 : "via non \"Remote SMTP\" router"
6917 );
6918
6919 fprintf(f, "--%s\n"
6920 "Content-type: message/delivery-status\n\n"
6921 "Reporting-MTA: dns; %s\n",
6922 bound, smtp_active_hostname);
6923
6924 if (dsn_envid)
6925 { /* must be decoded from xtext: see RFC 3461:6.3a */
6926 uschar *xdec_envid;
6927 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6928 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6929 else
6930 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6931 }
6932 fputc('\n', f);
6933
6934 for (addr_dsntmp = addr_senddsn;
6935 addr_dsntmp;
6936 addr_dsntmp = addr_dsntmp->next)
6937 {
6938 if (addr_dsntmp->dsn_orcpt)
6939 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6940
6941 fprintf(f, "Action: delivered\n"
6942 "Final-Recipient: rfc822;%s\n"
6943 "Status: 2.0.0\n",
6944 addr_dsntmp->address);
6945
6946 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6947 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6948 addr_dsntmp->host_used->name);
6949 else
6950 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6951 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6952 }
6953
6954 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6955
6956 fflush(f);
6957 transport_filter_argv = NULL; /* Just in case */
6958 return_path = sender_address; /* In case not previously set */
6959
6960 /* Write the original email out */
6961 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6962 fflush(f);
6963
6964 fprintf(f,"\n--%s--\n", bound);
6965
6966 fflush(f);
6967 fclose(f);
6968 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6969 }
6970 }
6971
6972/* If any addresses failed, we must send a message to somebody, unless
6973af_ignore_error is set, in which case no action is taken. It is possible for
6974several messages to get sent if there are addresses with different
6975requirements. */
6976
6977while (addr_failed)
6978 {
6979 pid_t pid;
6980 int fd;
6981 uschar *logtod = tod_stamp(tod_log);
6982 address_item *addr;
6983 address_item *handled_addr = NULL;
6984 address_item **paddr;
6985 address_item *msgchain = NULL;
6986 address_item **pmsgchain = &msgchain;
6987
6988 /* There are weird cases when logging is disabled in the transport. However,
6989 there may not be a transport (address failed by a router). */
6990
6991 disable_logging = FALSE;
6992 if (addr_failed->transport)
6993 disable_logging = addr_failed->transport->disable_logging;
6994
6995 DEBUG(D_deliver)
6996 debug_printf("processing failed address %s\n", addr_failed->address);
6997
6998 /* There are only two ways an address in a bounce message can get here:
6999
7000 (1) When delivery was initially deferred, but has now timed out (in the call
7001 to retry_update() above). We can detect this by testing for
7002 af_retry_timedout. If the address does not have its own errors address,
7003 we arrange to ignore the error.
7004
7005 (2) If delivery failures for bounce messages are being ignored. We can detect
7006 this by testing for af_ignore_error. This will also be set if a bounce
7007 message has been autothawed and the ignore_bounce_errors_after time has
7008 passed. It might also be set if a router was explicitly configured to
7009 ignore errors (errors_to = "").
7010
7011 If neither of these cases obtains, something has gone wrong. Log the
7012 incident, but then ignore the error. */
7013
7014 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7015 {
7016 if ( !testflag(addr_failed, af_retry_timedout)
7017 && !testflag(addr_failed, af_ignore_error))
7018 {
7019 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7020 "failure is neither frozen nor ignored (it's been ignored)");
7021 }
7022 setflag(addr_failed, af_ignore_error);
7023 }
7024
7025 /* If the first address on the list has af_ignore_error set, just remove
7026 it from the list, throw away any saved message file, log it, and
7027 mark the recipient done. */
7028
7029 if ( testflag(addr_failed, af_ignore_error)
7030 || ( addr_failed->dsn_flags & rf_dsnflags
7031 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure
7032 ) )
7033 {
7034 addr = addr_failed;
7035 addr_failed = addr->next;
7036 if (addr->return_filename) Uunlink(addr->return_filename);
7037
7038 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
7039 addr->address,
7040 !addr->parent ? US"" : US" <",
7041 !addr->parent ? US"" : addr->parent->address,
7042 !addr->parent ? US"" : US">");
7043
7044 address_done(addr, logtod);
7045 child_done(addr, logtod);
7046 /* Panic-dies on error */
7047 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7048 }
7049
7050 /* Otherwise, handle the sending of a message. Find the error address for
7051 the first address, then send a message that includes all failed addresses
7052 that have the same error address. Note the bounce_recipient is a global so
7053 that it can be accesssed by $bounce_recipient while creating a customized
7054 error message. */
7055
7056 else
7057 {
7058 if (!(bounce_recipient = addr_failed->prop.errors_address))
7059 bounce_recipient = sender_address;
7060
7061 /* Make a subprocess to send a message */
7062
7063 if ((pid = child_open_exim(&fd)) < 0)
7064 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7065 "create child process to send failure message: %s", getpid(),
7066 getppid(), strerror(errno));
7067
7068 /* Creation of child succeeded */
7069
7070 else
7071 {
7072 int ch, rc;
7073 int filecount = 0;
7074 int rcount = 0;
7075 uschar *bcc, *emf_text;
7076 FILE *f = fdopen(fd, "wb");
7077 FILE *emf = NULL;
7078 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7079 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7080 DELIVER_IN_BUFFER_SIZE;
7081 uschar * bound;
7082 uschar *dsnlimitmsg;
7083 uschar *dsnnotifyhdr;
7084 int topt;
7085
7086 DEBUG(D_deliver)
7087 debug_printf("sending error message to: %s\n", bounce_recipient);
7088
7089 /* Scan the addresses for all that have the same errors address, removing
7090 them from the addr_failed chain, and putting them on msgchain. */
7091
7092 paddr = &addr_failed;
7093 for (addr = addr_failed; addr; addr = *paddr)
7094 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7095 ? addr->prop.errors_address : sender_address) == 0)
7096 { /* The same - dechain */
7097 *paddr = addr->next;
7098 *pmsgchain = addr;
7099 addr->next = NULL;
7100 pmsgchain = &(addr->next);
7101 }
7102 else
7103 paddr = &addr->next; /* Not the same; skip */
7104
7105 /* Include X-Failed-Recipients: for automatic interpretation, but do
7106 not let any one header line get too long. We do this by starting a
7107 new header every 50 recipients. Omit any addresses for which the
7108 "hide_child" flag is set. */
7109
7110 for (addr = msgchain; addr; addr = addr->next)
7111 {
7112 if (testflag(addr, af_hide_child)) continue;
7113 if (rcount >= 50)
7114 {
7115 fprintf(f, "\n");
7116 rcount = 0;
7117 }
7118 fprintf(f, "%s%s",
7119 rcount++ == 0
7120 ? "X-Failed-Recipients: "
7121 : ",\n ",
7122 testflag(addr, af_pfr) && addr->parent
7123 ? string_printing(addr->parent->address)
7124 : string_printing(addr->address));
7125 }
7126 if (rcount > 0) fprintf(f, "\n");
7127
7128 /* Output the standard headers */
7129
7130 if (errors_reply_to)
7131 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7132 fprintf(f, "Auto-Submitted: auto-replied\n");
7133 moan_write_from(f);
7134 fprintf(f, "To: %s\n", bounce_recipient);
7135
7136 /* generate boundary string and output MIME-Headers */
7137 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7138
7139 fprintf(f, "Content-Type: multipart/report;"
7140 " report-type=delivery-status; boundary=%s\n"
7141 "MIME-Version: 1.0\n",
7142 bound);
7143
7144 /* Open a template file if one is provided. Log failure to open, but
7145 carry on - default texts will be used. */
7146
7147 if (bounce_message_file)
7148 if (!(emf = Ufopen(bounce_message_file, "rb")))
7149 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7150 "message texts: %s", bounce_message_file, strerror(errno));
7151
7152 /* Quietly copy to configured additional addresses if required. */
7153
7154 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7155 fprintf(f, "Bcc: %s\n", bcc);
7156
7157 /* The texts for the message can be read from a template file; if there
7158 isn't one, or if it is too short, built-in texts are used. The first
7159 emf text is a Subject: and any other headers. */
7160
7161 if ((emf_text = next_emf(emf, US"header")))
7162 fprintf(f, "%s\n", emf_text);
7163 else
7164 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7165 to_sender? ": returning message to sender" : "");
7166
7167 /* output human readable part as text/plain section */
7168 fprintf(f, "--%s\n"
7169 "Content-type: text/plain; charset=us-ascii\n\n",
7170 bound);
7171
7172 if ((emf_text = next_emf(emf, US"intro")))
7173 fprintf(f, "%s", CS emf_text);
7174 else
7175 {
7176 fprintf(f,
7177/* This message has been reworded several times. It seems to be confusing to
7178somebody, however it is worded. I have retreated to the original, simple
7179wording. */
7180"This message was created automatically by mail delivery software.\n");
7181
7182 if (bounce_message_text)
7183 fprintf(f, "%s", CS bounce_message_text);
7184 if (to_sender)
7185 fprintf(f,
7186"\nA message that you sent could not be delivered to one or more of its\n"
7187"recipients. This is a permanent error. The following address(es) failed:\n");
7188 else
7189 fprintf(f,
7190"\nA message sent by\n\n <%s>\n\n"
7191"could not be delivered to one or more of its recipients. The following\n"
7192"address(es) failed:\n", sender_address);
7193 }
7194 fputc('\n', f);
7195
7196 /* Process the addresses, leaving them on the msgchain if they have a
7197 file name for a return message. (There has already been a check in
7198 post_process_one() for the existence of data in the message file.) A TRUE
7199 return from print_address_information() means that the address is not
7200 hidden. */
7201
7202 paddr = &msgchain;
7203 for (addr = msgchain; addr; addr = *paddr)
7204 {
7205 if (print_address_information(addr, f, US" ", US"\n ", US""))
7206 print_address_error(addr, f, US"");
7207
7208 /* End the final line for the address */
7209
7210 fputc('\n', f);
7211
7212 /* Leave on msgchain if there's a return file. */
7213
7214 if (addr->return_file >= 0)
7215 {
7216 paddr = &(addr->next);
7217 filecount++;
7218 }
7219
7220 /* Else save so that we can tick off the recipient when the
7221 message is sent. */
7222
7223 else
7224 {
7225 *paddr = addr->next;
7226 addr->next = handled_addr;
7227 handled_addr = addr;
7228 }
7229 }
7230
7231 fputc('\n', f);
7232
7233 /* Get the next text, whether we need it or not, so as to be
7234 positioned for the one after. */
7235
7236 emf_text = next_emf(emf, US"generated text");
7237
7238 /* If there were any file messages passed by the local transports,
7239 include them in the message. Then put the address on the handled chain.
7240 In the case of a batch of addresses that were all sent to the same
7241 transport, the return_file field in all of them will contain the same
7242 fd, and the return_filename field in the *last* one will be set (to the
7243 name of the file). */
7244
7245 if (msgchain)
7246 {
7247 address_item *nextaddr;
7248
7249 if (emf_text)
7250 fprintf(f, "%s", CS emf_text);
7251 else
7252 fprintf(f,
7253 "The following text was generated during the delivery "
7254 "attempt%s:\n", (filecount > 1)? "s" : "");
7255
7256 for (addr = msgchain; addr; addr = nextaddr)
7257 {
7258 FILE *fm;
7259 address_item *topaddr = addr;
7260
7261 /* List all the addresses that relate to this file */
7262
7263 fputc('\n', f);
7264 while(addr) /* Insurance */
7265 {
7266 print_address_information(addr, f, US"------ ", US"\n ",
7267 US" ------\n");
7268 if (addr->return_filename) break;
7269 addr = addr->next;
7270 }
7271 fputc('\n', f);
7272
7273 /* Now copy the file */
7274
7275 if (!(fm = Ufopen(addr->return_filename, "rb")))
7276 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7277 strerror(errno));
7278 else
7279 {
7280 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7281 (void)fclose(fm);
7282 }
7283 Uunlink(addr->return_filename);
7284
7285 /* Can now add to handled chain, first fishing off the next
7286 address on the msgchain. */
7287
7288 nextaddr = addr->next;
7289 addr->next = handled_addr;
7290 handled_addr = topaddr;
7291 }
7292 fputc('\n', f);
7293 }
7294
7295 /* output machine readable part */
7296#ifdef EXPERIMENTAL_INTERNATIONAL
7297 if (message_smtputf8)
7298 fprintf(f, "--%s\n"
7299 "Content-type: message/global-delivery-status\n\n"
7300 "Reporting-MTA: dns; %s\n",
7301 bound, smtp_active_hostname);
7302 else
7303#endif
7304 fprintf(f, "--%s\n"
7305 "Content-type: message/delivery-status\n\n"
7306 "Reporting-MTA: dns; %s\n",
7307 bound, smtp_active_hostname);
7308
7309 if (dsn_envid)
7310 {
7311 /* must be decoded from xtext: see RFC 3461:6.3a */
7312 uschar *xdec_envid;
7313 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7314 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7315 else
7316 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7317 }
7318 fputc('\n', f);
7319
7320 for (addr = handled_addr; addr; addr = addr->next)
7321 {
7322 host_item * hu;
7323 fprintf(f, "Action: failed\n"
7324 "Final-Recipient: rfc822;%s\n"
7325 "Status: 5.0.0\n",
7326 addr->address);
7327 if ((hu = addr->host_used) && hu->name)
7328 {
7329 const uschar * s;
7330 fprintf(f, "Remote-MTA: dns; %s\n",
7331 hu->name);
7332#ifdef EXPERIMENTAL_DSN_INFO
7333 if (hu->address)
7334 {
7335 uschar * p = hu->port == 25
7336 ? US"" : string_sprintf(":%d", hu->port);
7337 fprintf(f, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7338 }
7339 if ((s = addr->smtp_greeting) && *s)
7340 fprintf(f, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7341 if ((s = addr->helo_response) && *s)
7342 fprintf(f, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7343 if ((s = addr->message) && *s)
7344 fprintf(f, "X-Exim-Diagnostic: X-str; %s\n", s);
7345#endif
7346 print_dsn_diagnostic_code(addr, f);
7347 }
7348 fputc('\n', f);
7349 }
7350
7351 /* Now copy the message, trying to give an intelligible comment if
7352 it is too long for it all to be copied. The limit isn't strictly
7353 applied because of the buffering. There is, however, an option
7354 to suppress copying altogether. */
7355
7356 emf_text = next_emf(emf, US"copy");
7357
7358 /* add message body
7359 we ignore the intro text from template and add
7360 the text for bounce_return_size_limit at the end.
7361
7362 bounce_return_message is ignored
7363 in case RET= is defined we honor these values
7364 otherwise bounce_return_body is honored.
7365
7366 bounce_return_size_limit is always honored.
7367 */
7368
7369 fprintf(f, "--%s\n", bound);
7370
7371 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7372 dsnnotifyhdr = NULL;
7373 topt = topt_add_return_path;
7374
7375 /* RET=HDRS? top priority */
7376 if (dsn_ret == dsn_ret_hdrs)
7377 topt |= topt_no_body;
7378 else
7379 /* no full body return at all? */
7380 if (!bounce_return_body)
7381 {
7382 topt |= topt_no_body;
7383 /* add header if we overrule RET=FULL */
7384 if (dsn_ret == dsn_ret_full)
7385 dsnnotifyhdr = dsnlimitmsg;
7386 }
7387 /* size limited ... return headers only if limit reached */
7388 else if (bounce_return_size_limit > 0)
7389 {
7390 struct stat statbuf;
7391 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7392 {
7393 topt |= topt_no_body;
7394 dsnnotifyhdr = dsnlimitmsg;
7395 }
7396 }
7397
7398#ifdef EXPERIMENTAL_INTERNATIONAL
7399 if (message_smtputf8)
7400 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7401 : "Content-type: message/global\n\n",
7402 f);
7403 else
7404#endif
7405 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7406 : "Content-type: message/rfc822\n\n",
7407 f);
7408
7409 fflush(f);
7410 transport_filter_argv = NULL; /* Just in case */
7411 return_path = sender_address; /* In case not previously set */
7412 transport_write_message(NULL, fileno(f), topt,
7413 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7414 fflush(f);
7415
7416 /* we never add the final text. close the file */
7417 if (emf)
7418 (void)fclose(emf);
7419
7420 fprintf(f, "\n--%s--\n", bound);
7421
7422 /* Close the file, which should send an EOF to the child process
7423 that is receiving the message. Wait for it to finish. */
7424
7425 (void)fclose(f);
7426 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7427
7428 /* In the test harness, let the child do it's thing first. */
7429
7430 if (running_in_test_harness) millisleep(500);
7431
7432 /* If the process failed, there was some disaster in setting up the
7433 error message. Unless the message is very old, ensure that addr_defer
7434 is non-null, which will have the effect of leaving the message on the
7435 spool. The failed addresses will get tried again next time. However, we
7436 don't really want this to happen too often, so freeze the message unless
7437 there are some genuine deferred addresses to try. To do this we have
7438 to call spool_write_header() here, because with no genuine deferred
7439 addresses the normal code below doesn't get run. */
7440
7441 if (rc != 0)
7442 {
7443 uschar *s = US"";
7444 if (now - received_time < retry_maximum_timeout && !addr_defer)
7445 {
7446 addr_defer = (address_item *)(+1);
7447 deliver_freeze = TRUE;
7448 deliver_frozen_at = time(NULL);
7449 /* Panic-dies on error */
7450 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7451 s = US" (frozen)";
7452 }
7453 deliver_msglog("Process failed (%d) when writing error message "
7454 "to %s%s", rc, bounce_recipient, s);
7455 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7456 "to %s%s", rc, bounce_recipient, s);
7457 }
7458
7459 /* The message succeeded. Ensure that the recipients that failed are
7460 now marked finished with on the spool and their parents updated. */
7461
7462 else
7463 {
7464 for (addr = handled_addr; addr; addr = addr->next)
7465 {
7466 address_done(addr, logtod);
7467 child_done(addr, logtod);
7468 }
7469 /* Panic-dies on error */
7470 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7471 }
7472 }
7473 }
7474 }
7475
7476disable_logging = FALSE; /* In case left set */
7477
7478/* Come here from the mua_wrapper case if routing goes wrong */
7479
7480DELIVERY_TIDYUP:
7481
7482/* If there are now no deferred addresses, we are done. Preserve the
7483message log if so configured, and we are using them. Otherwise, sling it.
7484Then delete the message itself. */
7485
7486if (!addr_defer)
7487 {
7488 if (message_logs)
7489 {
7490 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7491 id);
7492 if (preserve_message_logs)
7493 {
7494 int rc;
7495 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7496 if ((rc = Urename(spoolname, big_buffer)) < 0)
7497 {
7498 (void)directory_make(spool_directory, US"msglog.OLD",
7499 MSGLOG_DIRECTORY_MODE, TRUE);
7500 rc = Urename(spoolname, big_buffer);
7501 }
7502 if (rc < 0)
7503 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7504 "msglog.OLD directory", spoolname);
7505 }
7506 else
7507 if (Uunlink(spoolname) < 0)
7508 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7509 spoolname, strerror(errno));
7510 }
7511
7512 /* Remove the two message files. */
7513
7514 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7515 if (Uunlink(spoolname) < 0)
7516 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7517 spoolname, strerror(errno));
7518 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7519 if (Uunlink(spoolname) < 0)
7520 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7521 spoolname, strerror(errno));
7522
7523 /* Log the end of this message, with queue time if requested. */
7524
7525 if (LOGGING(queue_time_overall))
7526 log_write(0, LOG_MAIN, "Completed QT=%s",
7527 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7528 else
7529 log_write(0, LOG_MAIN, "Completed");
7530
7531 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7532 deliver_freeze = FALSE;
7533
7534#ifdef EXPERIMENTAL_EVENT
7535 (void) event_raise(event_action, US"msg:complete", NULL);
7536#endif
7537 }
7538
7539/* If there are deferred addresses, we are keeping this message because it is
7540not yet completed. Lose any temporary files that were catching output from
7541pipes for any of the deferred addresses, handle one-time aliases, and see if
7542the message has been on the queue for so long that it is time to send a warning
7543message to the sender, unless it is a mailer-daemon. If all deferred addresses
7544have the same domain, we can set deliver_domain for the expansion of
7545delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7546the parent's domain.
7547
7548If all the deferred addresses have an error number that indicates "retry time
7549not reached", skip sending the warning message, because it won't contain the
7550reason for the delay. It will get sent at the next real delivery attempt.
7551However, if at least one address has tried, we'd better include all of them in
7552the message.
7553
7554If we can't make a process to send the message, don't worry.
7555
7556For mailing list expansions we want to send the warning message to the
7557mailing list manager. We can't do a perfect job here, as some addresses may
7558have different errors addresses, but if we take the errors address from
7559each deferred address it will probably be right in most cases.
7560
7561If addr_defer == +1, it means there was a problem sending an error message
7562for failed addresses, and there were no "real" deferred addresses. The value
7563was set just to keep the message on the spool, so there is nothing to do here.
7564*/
7565
7566else if (addr_defer != (address_item *)(+1))
7567 {
7568 address_item *addr;
7569 uschar *recipients = US"";
7570 BOOL delivery_attempted = FALSE;
7571
7572 deliver_domain = testflag(addr_defer, af_pfr)
7573 ? addr_defer->parent->domain : addr_defer->domain;
7574
7575 for (addr = addr_defer; addr; addr = addr->next)
7576 {
7577 address_item *otaddr;
7578
7579 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7580
7581 if (deliver_domain)
7582 {
7583 const uschar *d = testflag(addr, af_pfr)
7584 ? addr->parent->domain : addr->domain;
7585
7586 /* The domain may be unset for an address that has never been routed
7587 because the system filter froze the message. */
7588
7589 if (!d || Ustrcmp(d, deliver_domain) != 0)
7590 deliver_domain = NULL;
7591 }
7592
7593 if (addr->return_filename) Uunlink(addr->return_filename);
7594
7595 /* Handle the case of one-time aliases. If any address in the ancestry
7596 of this one is flagged, ensure it is in the recipients list, suitably
7597 flagged, and that its parent is marked delivered. */
7598
7599 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
7600 if (otaddr->onetime_parent) break;
7601
7602 if (otaddr)
7603 {
7604 int i;
7605 int t = recipients_count;
7606
7607 for (i = 0; i < recipients_count; i++)
7608 {
7609 uschar *r = recipients_list[i].address;
7610 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7611 if (Ustrcmp(otaddr->address, r) == 0) break;
7612 }
7613
7614 /* Didn't find the address already in the list, and did find the
7615 ultimate parent's address in the list. After adding the recipient,
7616 update the errors address in the recipients list. */
7617
7618 if (i >= recipients_count && t < recipients_count)
7619 {
7620 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7621 otaddr->address, otaddr->parent->address);
7622 receive_add_recipient(otaddr->address, t);
7623 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
7624 tree_add_nonrecipient(otaddr->parent->address);
7625 update_spool = TRUE;
7626 }
7627 }
7628
7629 /* Except for error messages, ensure that either the errors address for
7630 this deferred address or, if there is none, the sender address, is on the
7631 list of recipients for a warning message. */
7632
7633 if (sender_address[0] != 0)
7634 if (addr->prop.errors_address)
7635 {
7636 if (Ustrstr(recipients, addr->prop.errors_address) == NULL)
7637 recipients = string_sprintf("%s%s%s", recipients,
7638 (recipients[0] == 0)? "" : ",", addr->prop.errors_address);
7639 }
7640 else
7641 {
7642 if (Ustrstr(recipients, sender_address) == NULL)
7643 recipients = string_sprintf("%s%s%s", recipients,
7644 (recipients[0] == 0)? "" : ",", sender_address);
7645 }
7646 }
7647
7648 /* Send a warning message if the conditions are right. If the condition check
7649 fails because of a lookup defer, there is nothing we can do. The warning
7650 is not sent. Another attempt will be made at the next delivery attempt (if
7651 it also defers). */
7652
7653 if ( !queue_2stage
7654 && delivery_attempted
7655 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7656 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7657 )
7658 && delay_warning[1] > 0
7659 && sender_address[0] != 0
7660 && ( !delay_warning_condition
7661 || expand_check_condition(delay_warning_condition,
7662 US"delay_warning", US"option")
7663 )
7664 )
7665 {
7666 int count;
7667 int show_time;
7668 int queue_time = time(NULL) - received_time;
7669
7670 /* When running in the test harness, there's an option that allows us to
7671 fudge this time so as to get repeatability of the tests. Take the first
7672 time off the list. In queue runs, the list pointer gets updated in the
7673 calling process. */
7674
7675 if (running_in_test_harness && fudged_queue_times[0] != 0)
7676 {
7677 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7678 if (qt >= 0)
7679 {
7680 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7681 fudged_queue_times);
7682 queue_time = qt;
7683 }
7684 }
7685
7686 /* See how many warnings we should have sent by now */
7687
7688 for (count = 0; count < delay_warning[1]; count++)
7689 if (queue_time < delay_warning[count+2]) break;
7690
7691 show_time = delay_warning[count+1];
7692
7693 if (count >= delay_warning[1])
7694 {
7695 int extra;
7696 int last_gap = show_time;
7697 if (count > 1) last_gap -= delay_warning[count];
7698 extra = (queue_time - delay_warning[count+1])/last_gap;
7699 show_time += last_gap * extra;
7700 count += extra;
7701 }
7702
7703 DEBUG(D_deliver)
7704 {
7705 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7706 debug_printf("warning counts: required %d done %d\n", count,
7707 warning_count);
7708 }
7709
7710 /* We have computed the number of warnings there should have been by now.
7711 If there haven't been enough, send one, and up the count to what it should
7712 have been. */
7713
7714 if (warning_count < count)
7715 {
7716 header_line *h;
7717 int fd;
7718 pid_t pid = child_open_exim(&fd);
7719
7720 if (pid > 0)
7721 {
7722 uschar *wmf_text;
7723 FILE *wmf = NULL;
7724 FILE *f = fdopen(fd, "wb");
7725 uschar * bound;
7726
7727 if (warn_message_file)
7728 if (!(wmf = Ufopen(warn_message_file, "rb")))
7729 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7730 "message texts: %s", warn_message_file, strerror(errno));
7731
7732 warnmsg_recipients = recipients;
7733 warnmsg_delay = queue_time < 120*60
7734 ? string_sprintf("%d minutes", show_time/60)
7735 : string_sprintf("%d hours", show_time/3600);
7736
7737 if (errors_reply_to)
7738 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7739 fprintf(f, "Auto-Submitted: auto-replied\n");
7740 moan_write_from(f);
7741 fprintf(f, "To: %s\n", recipients);
7742
7743 /* generated boundary string and output MIME-Headers */
7744 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7745
7746 fprintf(f, "Content-Type: multipart/report;"
7747 " report-type=delivery-status; boundary=%s\n"
7748 "MIME-Version: 1.0\n",
7749 bound);
7750
7751 if ((wmf_text = next_emf(wmf, US"header")))
7752 fprintf(f, "%s\n", wmf_text);
7753 else
7754 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7755 message_id, warnmsg_delay);
7756
7757 /* output human readable part as text/plain section */
7758 fprintf(f, "--%s\n"
7759 "Content-type: text/plain; charset=us-ascii\n\n",
7760 bound);
7761
7762 if ((wmf_text = next_emf(wmf, US"intro")))
7763 fprintf(f, "%s", CS wmf_text);
7764 else
7765 {
7766 fprintf(f,
7767"This message was created automatically by mail delivery software.\n");
7768
7769 if (Ustrcmp(recipients, sender_address) == 0)
7770 fprintf(f,
7771"A message that you sent has not yet been delivered to one or more of its\n"
7772"recipients after more than ");
7773
7774 else
7775 fprintf(f,
7776"A message sent by\n\n <%s>\n\n"
7777"has not yet been delivered to one or more of its recipients after more than \n",
7778 sender_address);
7779
7780 fprintf(f, "%s on the queue on %s.\n\n"
7781 "The message identifier is: %s\n",
7782 warnmsg_delay, primary_hostname, message_id);
7783
7784 for (h = header_list; h; h = h->next)
7785 if (strncmpic(h->text, US"Subject:", 8) == 0)
7786 fprintf(f, "The subject of the message is: %s", h->text + 9);
7787 else if (strncmpic(h->text, US"Date:", 5) == 0)
7788 fprintf(f, "The date of the message is: %s", h->text + 6);
7789 fputc('\n', f);
7790
7791 fprintf(f, "The address%s to which the message has not yet been "
7792 "delivered %s:\n",
7793 !addr_defer->next ? "" : "es",
7794 !addr_defer->next ? "is": "are");
7795 }
7796
7797 /* List the addresses, with error information if allowed */
7798
7799 /* store addr_defer for machine readable part */
7800 address_item *addr_dsndefer = addr_defer;
7801 fputc('\n', f);
7802 while (addr_defer)
7803 {
7804 address_item *addr = addr_defer;
7805 addr_defer = addr->next;
7806 if (print_address_information(addr, f, US" ", US"\n ", US""))
7807 print_address_error(addr, f, US"Delay reason: ");
7808 fputc('\n', f);
7809 }
7810 fputc('\n', f);
7811
7812 /* Final text */
7813
7814 if (wmf)
7815 {
7816 if ((wmf_text = next_emf(wmf, US"final")))
7817 fprintf(f, "%s", CS wmf_text);
7818 (void)fclose(wmf);
7819 }
7820 else
7821 {
7822 fprintf(f,
7823"No action is required on your part. Delivery attempts will continue for\n"
7824"some time, and this warning may be repeated at intervals if the message\n"
7825"remains undelivered. Eventually the mail delivery software will give up,\n"
7826"and when that happens, the message will be returned to you.\n");
7827 }
7828
7829 /* output machine readable part */
7830 fprintf(f, "\n--%s\n"
7831 "Content-type: message/delivery-status\n\n"
7832 "Reporting-MTA: dns; %s\n",
7833 bound,
7834 smtp_active_hostname);
7835
7836
7837 if (dsn_envid)
7838 {
7839 /* must be decoded from xtext: see RFC 3461:6.3a */
7840 uschar *xdec_envid;
7841 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7842 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7843 else
7844 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7845 }
7846 fputc('\n', f);
7847
7848 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
7849 {
7850 if (addr_dsndefer->dsn_orcpt)
7851 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7852
7853 fprintf(f, "Action: delayed\n"
7854 "Final-Recipient: rfc822;%s\n"
7855 "Status: 4.0.0\n",
7856 addr_dsndefer->address);
7857 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7858 {
7859 fprintf(f, "Remote-MTA: dns; %s\n",
7860 addr_dsndefer->host_used->name);
7861 print_dsn_diagnostic_code(addr_dsndefer, f);
7862 }
7863 fputc('\n', f);
7864 }
7865
7866 fprintf(f, "--%s\n"
7867 "Content-type: text/rfc822-headers\n\n",
7868 bound);
7869
7870 fflush(f);
7871 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7872 int topt = topt_add_return_path | topt_no_body;
7873 transport_filter_argv = NULL; /* Just in case */
7874 return_path = sender_address; /* In case not previously set */
7875 /* Write the original email out */
7876 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7877 fflush(f);
7878
7879 fprintf(f,"\n--%s--\n", bound);
7880
7881 fflush(f);
7882
7883 /* Close and wait for child process to complete, without a timeout.
7884 If there's an error, don't update the count. */
7885
7886 (void)fclose(f);
7887 if (child_close(pid, 0) == 0)
7888 {
7889 warning_count = count;
7890 update_spool = TRUE; /* Ensure spool rewritten */
7891 }
7892 }
7893 }
7894 }
7895
7896 /* Clear deliver_domain */
7897
7898 deliver_domain = NULL;
7899
7900 /* If this was a first delivery attempt, unset the first time flag, and
7901 ensure that the spool gets updated. */
7902
7903 if (deliver_firsttime)
7904 {
7905 deliver_firsttime = FALSE;
7906 update_spool = TRUE;
7907 }
7908
7909 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7910 message, unless the message is a local error message (to avoid loops). Then
7911 log the freezing. If the text in "frozen_info" came from a system filter,
7912 it has been escaped into printing characters so as not to mess up log lines.
7913 For the "tell" message, we turn \n back into newline. Also, insert a newline
7914 near the start instead of the ": " string. */
7915
7916 if (deliver_freeze)
7917 {
7918 if (freeze_tell && freeze_tell[0] != 0 && !local_error_message)
7919 {
7920 uschar *s = string_copy(frozen_info);
7921 uschar *ss = Ustrstr(s, " by the system filter: ");
7922
7923 if (ss != NULL)
7924 {
7925 ss[21] = '.';
7926 ss[22] = '\n';
7927 }
7928
7929 ss = s;
7930 while (*ss != 0)
7931 {
7932 if (*ss == '\\' && ss[1] == 'n')
7933 {
7934 *ss++ = ' ';
7935 *ss++ = '\n';
7936 }
7937 else ss++;
7938 }
7939 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7940 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7941 s, sender_address);
7942 }
7943
7944 /* Log freezing just before we update the -H file, to minimize the chance
7945 of a race problem. */
7946
7947 deliver_msglog("*** Frozen%s\n", frozen_info);
7948 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7949 }
7950
7951 /* If there have been any updates to the non-recipients list, or other things
7952 that get written to the spool, we must now update the spool header file so
7953 that it has the right information for the next delivery attempt. If there
7954 was more than one address being delivered, the header_change update is done
7955 earlier, in case one succeeds and then something crashes. */
7956
7957 DEBUG(D_deliver)
7958 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7959 update_spool, header_rewritten);
7960
7961 if (update_spool || header_rewritten)
7962 /* Panic-dies on error */
7963 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7964 }
7965
7966/* Finished with the message log. If the message is complete, it will have
7967been unlinked or renamed above. */
7968
7969if (message_logs) (void)fclose(message_log);
7970
7971/* Now we can close and remove the journal file. Its only purpose is to record
7972successfully completed deliveries asap so that this information doesn't get
7973lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7974not serious, as trying it again is not harmful. The journal might not be open
7975if all addresses were deferred at routing or directing. Nevertheless, we must
7976remove it if it exists (may have been lying around from a crash during the
7977previous delivery attempt). We don't remove the journal if a delivery
7978subprocess failed to pass back delivery information; this is controlled by
7979the remove_journal flag. When the journal is left, we also don't move the
7980message off the main spool if frozen and the option is set. It should get moved
7981at the next attempt, after the journal has been inspected. */
7982
7983if (journal_fd >= 0) (void)close(journal_fd);
7984
7985if (remove_journal)
7986 {
7987 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7988 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7989 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7990 strerror(errno));
7991
7992 /* Move the message off the spool if reqested */
7993
7994#ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7995 if (deliver_freeze && move_frozen_messages)
7996 (void)spool_move_message(id, message_subdir, US"", US"F");
7997#endif
7998 }
7999
8000/* Closing the data file frees the lock; if the file has been unlinked it
8001will go away. Otherwise the message becomes available for another process
8002to try delivery. */
8003
8004(void)close(deliver_datafile);
8005deliver_datafile = -1;
8006DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8007
8008/* It is unlikely that there will be any cached resources, since they are
8009released after routing, and in the delivery subprocesses. However, it's
8010possible for an expansion for something afterwards (for example,
8011expand_check_condition) to do a lookup. We must therefore be sure everything is
8012released. */
8013
8014search_tidyup();
8015acl_where = ACL_WHERE_UNKNOWN;
8016return final_yield;
8017}
8018
8019
8020
8021void
8022deliver_init(void)
8023{
8024if (!regex_PIPELINING) regex_PIPELINING =
8025 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8026
8027if (!regex_SIZE) regex_SIZE =
8028 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8029
8030if (!regex_AUTH) regex_AUTH =
8031 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
8032 FALSE, TRUE);
8033
8034#ifdef SUPPORT_TLS
8035if (!regex_STARTTLS) regex_STARTTLS =
8036 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8037#endif
8038
8039#ifndef DISABLE_PRDR
8040if (!regex_PRDR) regex_PRDR =
8041 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8042#endif
8043
8044#ifdef EXPERIMENTAL_INTERNATIONAL
8045if (!regex_UTF8) regex_UTF8 =
8046 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8047#endif
8048
8049if (!regex_DSN) regex_DSN =
8050 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8051
8052if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8053 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8054}
8055
8056
8057uschar *
8058deliver_get_sender_address (uschar * id)
8059{
8060int rc;
8061uschar * new_sender_address,
8062 * save_sender_address;
8063
8064if (!spool_open_datafile(id))
8065 return NULL;
8066
8067/* Save and restore the global sender_address. I'm not sure if we should
8068not save/restore all the other global variables too, because
8069spool_read_header() may change all of them. But OTOH, when this
8070deliver_get_sender_address() gets called, the current message is done
8071already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8072
8073sprintf(CS spoolname, "%s-H", id);
8074save_sender_address = sender_address;
8075
8076rc = spool_read_header(spoolname, TRUE, TRUE);
8077
8078new_sender_address = sender_address;
8079sender_address = save_sender_address;
8080
8081if (rc != spool_read_OK)
8082 return NULL;
8083
8084assert(new_sender_address);
8085
8086(void)close(deliver_datafile);
8087deliver_datafile = -1;
8088
8089return new_sender_address;
8090}
8091
8092/* vi: aw ai sw=2
8093*/
8094/* End of deliver.c */