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