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