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