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