Fix too-often retry bug after 4xx with more hosts than hosts_max_retry.
[exim.git] / src / src / deliver.c
CommitLineData
f6c332bd 1/* $Cambridge: exim/src/src/deliver.c,v 1.37 2006/10/30 16:41:04 ph10 Exp $ */
059ec3d9
PH
2
3/*************************************************
4* Exim - an Internet mail transport agent *
5*************************************************/
6
d7d7b7b9 7/* Copyright (c) University of Cambridge 1995 - 2006 */
059ec3d9
PH
8/* See the file NOTICE for conditions of use and distribution. */
9
10/* The main code for delivering a message. */
11
12
13#include "exim.h"
14
15
16/* Data block for keeping track of subprocesses for parallel remote
17delivery. */
18
19typedef struct pardata {
20 address_item *addrlist; /* chain of addresses */
21 address_item *addr; /* next address data expected for */
22 pid_t pid; /* subprocess pid */
23 int fd; /* pipe fd for getting result from subprocess */
24 int transport_count; /* returned transport count value */
25 BOOL done; /* no more data needed */
26 uschar *msg; /* error message */
27 uschar *return_path; /* return_path for these addresses */
28} pardata;
29
30/* Values for the process_recipients variable */
31
32enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
33 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
34 RECIP_FAIL_LOOP};
35
36/* Mutually recursive functions for marking addresses done. */
37
38static void child_done(address_item *, uschar *);
39static void address_done(address_item *, uschar *);
40
41/* Table for turning base-62 numbers into binary */
42
43static uschar tab62[] =
44 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
45 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
46 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
47 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
48 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
49 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
50 59,60,61}; /* x-z */
51
52
53/*************************************************
54* Local static variables *
55*************************************************/
56
57/* addr_duplicate is global because it needs to be seen from the Envelope-To
58writing code. */
59
60static address_item *addr_defer = NULL;
61static address_item *addr_failed = NULL;
62static address_item *addr_fallback = NULL;
63static address_item *addr_local = NULL;
64static address_item *addr_new = NULL;
65static address_item *addr_remote = NULL;
66static address_item *addr_route = NULL;
67static address_item *addr_succeed = NULL;
68
69static FILE *message_log = NULL;
70static BOOL update_spool;
71static BOOL remove_journal;
72static int parcount = 0;
73static pardata *parlist = NULL;
74static int return_count;
75static uschar *frozen_info = US"";
76static uschar *used_return_path = NULL;
77
78static uschar spoolname[PATH_MAX];
79
80
81
82/*************************************************
83* Make a new address item *
84*************************************************/
85
86/* This function gets the store and initializes with default values. The
87transport_return value defaults to DEFER, so that any unexpected failure to
88deliver does not wipe out the message. The default unique string is set to a
89copy of the address, so that its domain can be lowercased.
90
91Argument:
92 address the RFC822 address string
93 copy force a copy of the address
94
95Returns: a pointer to an initialized address_item
96*/
97
98address_item *
99deliver_make_addr(uschar *address, BOOL copy)
100{
101address_item *addr = store_get(sizeof(address_item));
102*addr = address_defaults;
103if (copy) address = string_copy(address);
104addr->address = address;
105addr->unique = string_copy(address);
106return addr;
107}
108
109
110
111
112/*************************************************
113* Set expansion values for an address *
114*************************************************/
115
116/* Certain expansion variables are valid only when handling an address or
117address list. This function sets them up or clears the values, according to its
118argument.
119
120Arguments:
121 addr the address in question, or NULL to clear values
122Returns: nothing
123*/
124
125void
126deliver_set_expansions(address_item *addr)
127{
128if (addr == NULL)
129 {
130 uschar ***p = address_expansions;
131 while (*p != NULL) **p++ = NULL;
132 return;
133 }
134
135/* Exactly what gets set depends on whether there is one or more addresses, and
136what they contain. These first ones are always set, taking their values from
137the first address. */
138
139if (addr->host_list == NULL)
140 {
141 deliver_host = deliver_host_address = US"";
142 }
143else
144 {
145 deliver_host = addr->host_list->name;
146 deliver_host_address = addr->host_list->address;
147 }
148
149deliver_recipients = addr;
150deliver_address_data = addr->p.address_data;
151deliver_domain_data = addr->p.domain_data;
152deliver_localpart_data = addr->p.localpart_data;
153
154/* These may be unset for multiple addresses */
155
156deliver_domain = addr->domain;
157self_hostname = addr->self_hostname;
158
8523533c
TK
159#ifdef EXPERIMENTAL_BRIGHTMAIL
160bmi_deliver = 1; /* deliver by default */
161bmi_alt_location = NULL;
162bmi_base64_verdict = NULL;
163bmi_base64_tracker_verdict = NULL;
164#endif
165
059ec3d9
PH
166/* If there's only one address we can set everything. */
167
168if (addr->next == NULL)
169 {
170 address_item *addr_orig;
171
172 deliver_localpart = addr->local_part;
173 deliver_localpart_prefix = addr->prefix;
174 deliver_localpart_suffix = addr->suffix;
175
176 for (addr_orig = addr; addr_orig->parent != NULL;
177 addr_orig = addr_orig->parent);
178 deliver_domain_orig = addr_orig->domain;
179
180 /* Re-instate any prefix and suffix in the original local part. In all
181 normal cases, the address will have a router associated with it, and we can
182 choose the caseful or caseless version accordingly. However, when a system
183 filter sets up a pipe, file, or autoreply delivery, no router is involved.
184 In this case, though, there won't be any prefix or suffix to worry about. */
185
186 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
187 addr_orig->router->caseful_local_part?
188 addr_orig->cc_local_part : addr_orig->lc_local_part;
189
190 /* If there's a parent, make its domain and local part available, and if
191 delivering to a pipe or file, or sending an autoreply, get the local
192 part from the parent. For pipes and files, put the pipe or file string
193 into address_pipe and address_file. */
194
195 if (addr->parent != NULL)
196 {
197 deliver_domain_parent = addr->parent->domain;
198 deliver_localpart_parent = (addr->parent->router == NULL)?
199 addr->parent->local_part :
200 addr->parent->router->caseful_local_part?
201 addr->parent->cc_local_part : addr->parent->lc_local_part;
202
203 /* File deliveries have their own flag because they need to be picked out
204 as special more often. */
205
206 if (testflag(addr, af_pfr))
207 {
208 if (testflag(addr, af_file)) address_file = addr->local_part;
209 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
210 deliver_localpart = addr->parent->local_part;
211 deliver_localpart_prefix = addr->parent->prefix;
212 deliver_localpart_suffix = addr->parent->suffix;
213 }
214 }
8523533c
TK
215
216#ifdef EXPERIMENTAL_BRIGHTMAIL
217 /* Set expansion variables related to Brightmail AntiSpam */
218 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
219 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
220 /* get message delivery status (0 - don't deliver | 1 - deliver) */
221 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
222 /* if message is to be delivered, get eventual alternate location */
223 if (bmi_deliver == 1) {
224 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
225 };
226#endif
227
059ec3d9
PH
228 }
229
230/* For multiple addresses, don't set local part, and leave the domain and
f7fd3850
PH
231self_hostname set only if it is the same for all of them. It is possible to
232have multiple pipe and file addresses, but only when all addresses have routed
233to the same pipe or file. */
059ec3d9
PH
234
235else
236 {
237 address_item *addr2;
f7fd3850
PH
238 if (testflag(addr, af_pfr))
239 {
240 if (testflag(addr, af_file)) address_file = addr->local_part;
241 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
242 }
059ec3d9
PH
243 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
244 {
245 if (deliver_domain != NULL &&
246 Ustrcmp(deliver_domain, addr2->domain) != 0)
247 deliver_domain = NULL;
248 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
249 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
250 self_hostname = NULL;
251 if (deliver_domain == NULL && self_hostname == NULL) break;
252 }
253 }
254}
255
256
257
258
259/*************************************************
260* Open a msglog file *
261*************************************************/
262
263/* This function is used both for normal message logs, and for files in the
264msglog directory that are used to catch output from pipes. Try to create the
265directory if it does not exist. From release 4.21, normal message logs should
266be created when the message is received.
267
268Argument:
269 filename the file name
270 mode the mode required
271 error used for saying what failed
272
273Returns: a file descriptor, or -1 (with errno set)
274*/
275
276static int
277open_msglog_file(uschar *filename, int mode, uschar **error)
278{
279int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
280
281if (fd < 0 && errno == ENOENT)
282 {
283 uschar temp[16];
284 sprintf(CS temp, "msglog/%s", message_subdir);
285 if (message_subdir[0] == 0) temp[6] = 0;
286 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
287 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
288 }
289
290/* Set the close-on-exec flag and change the owner to the exim uid/gid (this
291function is called as root). Double check the mode, because the group setting
292doesn't always get set automatically. */
293
294if (fd >= 0)
295 {
ff790e47 296 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
059ec3d9
PH
297 if (fchown(fd, exim_uid, exim_gid) < 0)
298 {
299 *error = US"chown";
300 return -1;
301 }
302 if (fchmod(fd, mode) < 0)
303 {
304 *error = US"chmod";
305 return -1;
306 }
307 }
308else *error = US"create";
309
310return fd;
311}
312
313
314
315
316/*************************************************
317* Write to msglog if required *
318*************************************************/
319
320/* Write to the message log, if configured. This function may also be called
321from transports.
322
323Arguments:
324 format a string format
325
326Returns: nothing
327*/
328
329void
330deliver_msglog(const char *format, ...)
331{
332va_list ap;
333if (!message_logs) return;
334va_start(ap, format);
335vfprintf(message_log, format, ap);
336fflush(message_log);
337va_end(ap);
338}
339
340
341
342
343/*************************************************
344* Replicate status for batch *
345*************************************************/
346
347/* When a transport handles a batch of addresses, it may treat them
348individually, or it may just put the status in the first one, and return FALSE,
349requesting that the status be copied to all the others externally. This is the
350replication function. As well as the status, it copies the transport pointer,
351which may have changed if appendfile passed the addresses on to a different
352transport.
353
354Argument: pointer to the first address in a chain
355Returns: nothing
356*/
357
358static void
359replicate_status(address_item *addr)
360{
361address_item *addr2;
362for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
363 {
364 addr2->transport = addr->transport;
365 addr2->transport_return = addr->transport_return;
366 addr2->basic_errno = addr->basic_errno;
367 addr2->more_errno = addr->more_errno;
368 addr2->special_action = addr->special_action;
369 addr2->message = addr->message;
370 addr2->user_message = addr->user_message;
371 }
372}
373
374
375
376/*************************************************
377* Compare lists of hosts *
378*************************************************/
379
380/* This function is given two pointers to chains of host items, and it yields
381TRUE if the lists refer to the same hosts in the same order, except that
382
383(1) Multiple hosts with the same non-negative MX values are permitted to appear
384 in different orders. Round-robinning nameservers can cause this to happen.
385
386(2) Multiple hosts with the same negative MX values less than MX_NONE are also
387 permitted to appear in different orders. This is caused by randomizing
388 hosts lists.
389
390This enables Exim to use a single SMTP transaction for sending to two entirely
391different domains that happen to end up pointing at the same hosts.
392
393Arguments:
394 one points to the first host list
395 two points to the second host list
396
397Returns: TRUE if the lists refer to the same host set
398*/
399
400static BOOL
401same_hosts(host_item *one, host_item *two)
402{
403while (one != NULL && two != NULL)
404 {
405 if (Ustrcmp(one->name, two->name) != 0)
406 {
407 int mx = one->mx;
408 host_item *end_one = one;
409 host_item *end_two = two;
410
411 /* Batch up only if there was no MX and the list was not randomized */
412
413 if (mx == MX_NONE) return FALSE;
414
415 /* Find the ends of the shortest sequence of identical MX values */
416
417 while (end_one->next != NULL && end_one->next->mx == mx &&
418 end_two->next != NULL && end_two->next->mx == mx)
419 {
420 end_one = end_one->next;
421 end_two = end_two->next;
422 }
423
424 /* If there aren't any duplicates, there's no match. */
425
426 if (end_one == one) return FALSE;
427
428 /* For each host in the 'one' sequence, check that it appears in the 'two'
429 sequence, returning FALSE if not. */
430
431 for (;;)
432 {
433 host_item *hi;
434 for (hi = two; hi != end_two->next; hi = hi->next)
435 if (Ustrcmp(one->name, hi->name) == 0) break;
436 if (hi == end_two->next) return FALSE;
437 if (one == end_one) break;
438 one = one->next;
439 }
440
441 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
442 Ensure both are pointing at the last host, and carry on as for equality. */
443
444 two = end_two;
445 }
446
447 /* Hosts matched */
448
449 one = one->next;
450 two = two->next;
451 }
452
453/* True if both are NULL */
454
455return (one == two);
456}
457
458
459
460/*************************************************
461* Compare header lines *
462*************************************************/
463
464/* This function is given two pointers to chains of header items, and it yields
465TRUE if they are the same header texts in the same order.
466
467Arguments:
468 one points to the first header list
469 two points to the second header list
470
471Returns: TRUE if the lists refer to the same header set
472*/
473
474static BOOL
475same_headers(header_line *one, header_line *two)
476{
477for (;;)
478 {
479 if (one == two) return TRUE; /* Includes the case where both NULL */
480 if (one == NULL || two == NULL) return FALSE;
481 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
482 one = one->next;
483 two = two->next;
484 }
485}
486
487
488
489/*************************************************
490* Compare string settings *
491*************************************************/
492
493/* This function is given two pointers to strings, and it returns
494TRUE if they are the same pointer, or if the two strings are the same.
495
496Arguments:
497 one points to the first string
498 two points to the second string
499
500Returns: TRUE or FALSE
501*/
502
503static BOOL
504same_strings(uschar *one, uschar *two)
505{
506if (one == two) return TRUE; /* Includes the case where both NULL */
507if (one == NULL || two == NULL) return FALSE;
508return (Ustrcmp(one, two) == 0);
509}
510
511
512
513/*************************************************
514* Compare uid/gid for addresses *
515*************************************************/
516
517/* This function is given a transport and two addresses. It yields TRUE if the
518uid/gid/initgroups settings for the two addresses are going to be the same when
519they are delivered.
520
521Arguments:
522 tp the transort
523 addr1 the first address
524 addr2 the second address
525
526Returns: TRUE or FALSE
527*/
528
529static BOOL
530same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
531{
532if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
533 {
534 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
535 (testflag(addr1, af_uid_set) &&
536 (addr1->uid != addr2->uid ||
537 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
538 return FALSE;
539 }
540
541if (!tp->gid_set && tp->expand_gid == NULL)
542 {
543 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
544 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
545 return FALSE;
546 }
547
548return TRUE;
549}
550
551
552
553
554/*************************************************
555* Record that an address is complete *
556*************************************************/
557
558/* This function records that an address is complete. This is straightforward
559for most addresses, where the unique address is just the full address with the
560domain lower cased. For homonyms (addresses that are the same as one of their
561ancestors) their are complications. Their unique addresses have \x\ prepended
562(where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
563cousins.
564
565Exim used to record the unique addresses of homonyms as "complete". This,
566however, fails when the pattern of redirection varies over time (e.g. if taking
567unseen copies at only some times of day) because the prepended numbers may vary
568from one delivery run to the next. This problem is solved by never recording
569prepended unique addresses as complete. Instead, when a homonymic address has
570actually been delivered via a transport, we record its basic unique address
571followed by the name of the transport. This is checked in subsequent delivery
572runs whenever an address is routed to a transport.
573
574If the completed address is a top-level one (has no parent, which means it
575cannot be homonymic) we also add the original address to the non-recipients
576tree, so that it gets recorded in the spool file and therefore appears as
577"done" in any spool listings. The original address may differ from the unique
578address in the case of the domain.
579
580Finally, this function scans the list of duplicates, marks as done any that
581match this address, and calls child_done() for their ancestors.
582
583Arguments:
584 addr address item that has been completed
585 now current time as a string
586
587Returns: nothing
588*/
589
590static void
591address_done(address_item *addr, uschar *now)
592{
593address_item *dup;
594
595update_spool = TRUE; /* Ensure spool gets updated */
596
597/* Top-level address */
598
599if (addr->parent == NULL)
600 {
601 tree_add_nonrecipient(addr->unique);
602 tree_add_nonrecipient(addr->address);
603 }
604
605/* Homonymous child address */
606
607else if (testflag(addr, af_homonym))
608 {
609 if (addr->transport != NULL)
610 {
611 tree_add_nonrecipient(
612 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
613 }
614 }
615
616/* Non-homonymous child address */
617
618else tree_add_nonrecipient(addr->unique);
619
620/* Check the list of duplicate addresses and ensure they are now marked
621done as well. */
622
623for (dup = addr_duplicate; dup != NULL; dup = dup->next)
624 {
625 if (Ustrcmp(addr->unique, dup->unique) == 0)
626 {
627 tree_add_nonrecipient(dup->address);
628 child_done(dup, now);
629 }
630 }
631}
632
633
634
635
636/*************************************************
637* Decrease counts in parents and mark done *
638*************************************************/
639
640/* This function is called when an address is complete. If there is a parent
641address, its count of children is decremented. If there are still other
642children outstanding, the function exits. Otherwise, if the count has become
643zero, address_done() is called to mark the parent and its duplicates complete.
644Then loop for any earlier ancestors.
645
646Arguments:
647 addr points to the completed address item
648 now the current time as a string, for writing to the message log
649
650Returns: nothing
651*/
652
653static void
654child_done(address_item *addr, uschar *now)
655{
656address_item *aa;
657while (addr->parent != NULL)
658 {
659 addr = addr->parent;
660 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
661 address_done(addr, now);
662
663 /* Log the completion of all descendents only when there is no ancestor with
664 the same original address. */
665
666 for (aa = addr->parent; aa != NULL; aa = aa->parent)
667 if (Ustrcmp(aa->address, addr->address) == 0) break;
668 if (aa != NULL) continue;
669
670 deliver_msglog("%s %s: children all complete\n", now, addr->address);
671 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
672 }
673}
674
675
676
677
678/*************************************************
679* Actions at the end of handling an address *
680*************************************************/
681
682/* This is a function for processing a single address when all that can be done
683with it has been done.
684
685Arguments:
686 addr points to the address block
687 result the result of the delivery attempt
688 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
689 driver_type indicates which type of driver (transport, or router) was last
690 to process the address
691 logchar '=' or '-' for use when logging deliveries with => or ->
692
693Returns: nothing
694*/
695
696static void
697post_process_one(address_item *addr, int result, int logflags, int driver_type,
698 int logchar)
699{
700uschar *now = tod_stamp(tod_log);
701uschar *driver_kind = NULL;
702uschar *driver_name = NULL;
703uschar *log_address;
704
705int size = 256; /* Used for a temporary, */
706int ptr = 0; /* expanding buffer, for */
707uschar *s; /* building log lines; */
708void *reset_point; /* released afterwards. */
709
710
711DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
712
713/* Set up driver kind and name for logging. Disable logging if the router or
714transport has disabled it. */
715
716if (driver_type == DTYPE_TRANSPORT)
717 {
718 if (addr->transport != NULL)
719 {
720 driver_name = addr->transport->name;
721 driver_kind = US" transport";
722 disable_logging = addr->transport->disable_logging;
723 }
724 else driver_kind = US"transporting";
725 }
726else if (driver_type == DTYPE_ROUTER)
727 {
728 if (addr->router != NULL)
729 {
730 driver_name = addr->router->name;
731 driver_kind = US" router";
732 disable_logging = addr->router->disable_logging;
733 }
734 else driver_kind = US"routing";
735 }
736
737/* If there's an error message set, ensure that it contains only printing
738characters - it should, but occasionally things slip in and this at least
49c2d5ea
PH
739stops the log format from getting wrecked. We also scan the message for an LDAP
740expansion item that has a password setting, and flatten the password. This is a
741fudge, but I don't know a cleaner way of doing this. (If the item is badly
742malformed, it won't ever have gone near LDAP.) */
059ec3d9 743
49c2d5ea
PH
744if (addr->message != NULL)
745 {
746 addr->message = string_printing(addr->message);
747 if (Ustrstr(addr->message, "failed to expand") != NULL &&
748 (Ustrstr(addr->message, "ldap:") != NULL ||
749 Ustrstr(addr->message, "ldapdn:") != NULL ||
750 Ustrstr(addr->message, "ldapm:") != NULL))
751 {
752 uschar *p = Ustrstr(addr->message, "pass=");
753 if (p != NULL)
754 {
755 p += 5;
756 while (*p != 0 && !isspace(*p)) *p++ = 'x';
757 }
758 }
759 }
059ec3d9
PH
760
761/* If we used a transport that has one of the "return_output" options set, and
762if it did in fact generate some output, then for return_output we treat the
763message as failed if it was not already set that way, so that the output gets
764returned to the sender, provided there is a sender to send it to. For
765return_fail_output, do this only if the delivery failed. Otherwise we just
766unlink the file, and remove the name so that if the delivery failed, we don't
767try to send back an empty or unwanted file. The log_output options operate only
768on a non-empty file.
769
770In any case, we close the message file, because we cannot afford to leave a
771file-descriptor for one address while processing (maybe very many) others. */
772
773if (addr->return_file >= 0 && addr->return_filename != NULL)
774 {
775 BOOL return_output = FALSE;
776 struct stat statbuf;
777 fsync(addr->return_file);
778
779 /* If there is no output, do nothing. */
780
781 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
782 {
783 transport_instance *tb = addr->transport;
784
785 /* Handle logging options */
786
787 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
788 (result == DEFER && tb->log_defer_output))
789 {
790 uschar *s;
791 FILE *f = Ufopen(addr->return_filename, "rb");
792 if (f == NULL)
793 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
794 "from %s transport: %s", addr->return_filename, tb->name,
795 strerror(errno));
796 else
797 {
798 s = US Ufgets(big_buffer, big_buffer_size, f);
799 if (s != NULL)
800 {
801 uschar *p = big_buffer + Ustrlen(big_buffer);
802 while (p > big_buffer && isspace(p[-1])) p--;
803 *p = 0;
804 s = string_printing(big_buffer);
805 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
806 addr->address, tb->name, s);
807 }
f1e894f3 808 (void)fclose(f);
059ec3d9
PH
809 }
810 }
811
812 /* Handle returning options, but only if there is an address to return
813 the text to. */
814
815 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
816 {
817 if (tb->return_output)
818 {
819 addr->transport_return = result = FAIL;
820 if (addr->basic_errno == 0 && addr->message == NULL)
821 addr->message = US"return message generated";
822 return_output = TRUE;
823 }
824 else
825 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
826 }
827 }
828
829 /* Get rid of the file unless it might be returned, but close it in
830 all cases. */
831
832 if (!return_output)
833 {
834 Uunlink(addr->return_filename);
835 addr->return_filename = NULL;
836 addr->return_file = -1;
837 }
838
f1e894f3 839 (void)close(addr->return_file);
059ec3d9
PH
840 }
841
842/* Create the address string for logging. Must not do this earlier, because
843an OK result may be changed to FAIL when a pipe returns text. */
844
845log_address = string_log_address(addr,
846 (log_write_selector & L_all_parents) != 0, result == OK);
847
848/* The sucess case happens only after delivery by a transport. */
849
850if (result == OK)
851 {
852 addr->next = addr_succeed;
853 addr_succeed = addr;
854
855 /* Call address_done() to ensure that we don't deliver to this address again,
856 and write appropriate things to the message log. If it is a child address, we
857 call child_done() to scan the ancestors and mark them complete if this is the
858 last child to complete. */
859
860 address_done(addr, now);
861 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
862
863 if (addr->parent == NULL)
864 {
865 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
866 driver_name, driver_kind);
867 }
868 else
869 {
870 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
871 addr->parent->address, driver_name, driver_kind);
872 child_done(addr, now);
873 }
874
875 /* Log the delivery on the main log. We use an extensible string to build up
876 the log line, and reset the store afterwards. Remote deliveries should always
877 have a pointer to the host item that succeeded; local deliveries can have a
878 pointer to a single host item in their host list, for use by the transport. */
879
880 s = reset_point = store_get(size);
881 s[ptr++] = logchar;
882
883 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
884
885 if ((log_extra_selector & LX_sender_on_delivery) != 0)
886 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
887
384152a6
TK
888 #ifdef EXPERIMENTAL_SRS
889 if(addr->p.srs_sender)
890 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
891 #endif
892
059ec3d9
PH
893 /* You might think that the return path must always be set for a successful
894 delivery; indeed, I did for some time, until this statement crashed. The case
895 when it is not set is for a delivery to /dev/null which is optimised by not
896 being run at all. */
897
898 if (used_return_path != NULL &&
899 (log_extra_selector & LX_return_path_on_delivery) != 0)
900 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
901
902 /* For a delivery from a system filter, there may not be a router */
903
904 if (addr->router != NULL)
905 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
906
907 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
908
909 if ((log_extra_selector & LX_delivery_size) != 0)
910 s = string_append(s, &size, &ptr, 2, US" S=",
911 string_sprintf("%d", transport_count));
912
913 /* Local delivery */
914
915 if (addr->transport->info->local)
916 {
917 if (addr->host_list != NULL)
918 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
919 if (addr->shadow_message != NULL)
920 s = string_cat(s, &size, &ptr, addr->shadow_message,
921 Ustrlen(addr->shadow_message));
922 }
923
924 /* Remote delivery */
925
926 else
927 {
928 if (addr->host_used != NULL)
929 {
930 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
931 US" [", addr->host_used->address, US"]");
932 if ((log_extra_selector & LX_outgoing_port) != 0)
933 s = string_append(s, &size, &ptr, 2, US":", string_sprintf("%d",
934 addr->host_used->port));
935 if (continue_sequence > 1)
936 s = string_cat(s, &size, &ptr, US"*", 1);
937 }
938
939 #ifdef SUPPORT_TLS
940 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
941 s = string_append(s, &size, &ptr, 2, US" X=", addr->cipher);
942 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
943 addr->cipher != NULL)
944 s = string_append(s, &size, &ptr, 2, US" CV=",
945 testflag(addr, af_cert_verified)? "yes":"no");
946 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
947 s = string_append(s, &size, &ptr, 3, US" DN=\"", addr->peerdn, US"\"");
948 #endif
949
950 if ((log_extra_selector & LX_smtp_confirmation) != 0 &&
951 addr->message != NULL)
952 {
953 int i;
954 uschar *p = big_buffer;
955 uschar *ss = addr->message;
956 *p++ = '\"';
957 for (i = 0; i < 100 && ss[i] != 0; i++)
958 {
959 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\';
960 *p++ = ss[i];
961 }
962 *p++ = '\"';
963 *p = 0;
964 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
965 }
966 }
967
968 /* Time on queue and actual time taken to deliver */
969
970 if ((log_extra_selector & LX_queue_time) != 0)
971 {
972 s = string_append(s, &size, &ptr, 2, US" QT=",
973 readconf_printtime(time(NULL) - received_time));
974 }
975
976 if ((log_extra_selector & LX_deliver_time) != 0)
977 {
978 s = string_append(s, &size, &ptr, 2, US" DT=",
979 readconf_printtime(addr->more_errno));
980 }
981
982 /* string_cat() always leaves room for the terminator. Release the
983 store we used to build the line after writing it. */
984
985 s[ptr] = 0;
986 log_write(0, LOG_MAIN, "%s", s);
987 store_reset(reset_point);
988 }
989
990
991/* Soft failure, or local delivery process failed; freezing may be
992requested. */
993
994else if (result == DEFER || result == PANIC)
995 {
996 if (result == PANIC) logflags |= LOG_PANIC;
997
998 /* This puts them on the chain in reverse order. Do not change this, because
999 the code for handling retries assumes that the one with the retry
1000 information is last. */
1001
1002 addr->next = addr_defer;
1003 addr_defer = addr;
1004
1005 /* The only currently implemented special action is to freeze the
1006 message. Logging of this is done later, just before the -H file is
1007 updated. */
1008
1009 if (addr->special_action == SPECIAL_FREEZE)
1010 {
1011 deliver_freeze = TRUE;
1012 deliver_frozen_at = time(NULL);
1013 update_spool = TRUE;
1014 }
1015
1016 /* If doing a 2-stage queue run, we skip writing to either the message
1017 log or the main log for SMTP defers. */
1018
1019 if (!queue_2stage || addr->basic_errno != 0)
1020 {
1021 uschar ss[32];
1022
1023 /* For errors of the type "retry time not reached" (also remotes skipped
1024 on queue run), logging is controlled by L_retry_defer. Note that this kind
1025 of error number is negative, and all the retry ones are less than any
1026 others. */
1027
1028 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1029 L_retry_defer : 0;
1030
1031 /* Build up the line that is used for both the message log and the main
1032 log. */
1033
1034 s = reset_point = store_get(size);
1035 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1036
1037 /* Either driver_name contains something and driver_kind contains
1038 " router" or " transport" (note the leading space), or driver_name is
1039 a null string and driver_kind contains "routing" without the leading
1040 space, if all routing has been deferred. When a domain has been held,
1041 so nothing has been done at all, both variables contain null strings. */
1042
1043 if (driver_name == NULL)
1044 {
1045 if (driver_kind != NULL)
1046 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1047 }
1048 else
1049 {
1050 if (driver_kind[1] == 't' && addr->router != NULL)
1051 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1052 Ustrcpy(ss, " ?=");
1053 ss[1] = toupper(driver_kind[1]);
1054 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1055 }
1056
1057 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1058 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1059
1060 if (addr->basic_errno > 0)
1061 s = string_append(s, &size, &ptr, 2, US": ",
1062 US strerror(addr->basic_errno));
1063
1064 if (addr->message != NULL)
1065 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1066
1067 s[ptr] = 0;
1068
1069 /* Log the deferment in the message log, but don't clutter it
1070 up with retry-time defers after the first delivery attempt. */
1071
1072 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1073 deliver_msglog("%s %s\n", now, s);
1074
1075 /* Write the main log and reset the store */
1076
1077 log_write(use_log_selector, logflags, "== %s", s);
1078 store_reset(reset_point);
1079 }
1080 }
1081
1082
1083/* Hard failure. If there is an address to which an error message can be sent,
1084put this address on the failed list. If not, put it on the deferred list and
1085freeze the mail message for human attention. The latter action can also be
1086explicitly requested by a router or transport. */
1087
1088else
1089 {
1090 /* If this is a delivery error, or a message for which no replies are
1091 wanted, and the message's age is greater than ignore_bounce_errors_after,
1092 force the af_ignore_error flag. This will cause the address to be discarded
1093 later (with a log entry). */
1094
1095 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1096 setflag(addr, af_ignore_error);
1097
1098 /* Freeze the message if requested, or if this is a bounce message (or other
652e1b65
PH
1099 message with null sender) and this address does not have its own errors
1100 address. However, don't freeze if errors are being ignored. The actual code
1101 to ignore occurs later, instead of sending a message. Logging of freezing
1102 occurs later, just before writing the -H file. */
059ec3d9
PH
1103
1104 if (!testflag(addr, af_ignore_error) &&
652e1b65
PH
1105 (addr->special_action == SPECIAL_FREEZE ||
1106 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1107 ))
059ec3d9
PH
1108 {
1109 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1110 (sender_local && !local_error_message)?
1111 US" (message created with -f <>)" : US" (delivery error message)";
1112 deliver_freeze = TRUE;
1113 deliver_frozen_at = time(NULL);
1114 update_spool = TRUE;
1115
1116 /* The address is put on the defer rather than the failed queue, because
1117 the message is being retained. */
1118
1119 addr->next = addr_defer;
1120 addr_defer = addr;
1121 }
1122
1123 /* Don't put the address on the nonrecipients tree yet; wait until an
1124 error message has been successfully sent. */
1125
1126 else
1127 {
1128 addr->next = addr_failed;
1129 addr_failed = addr;
1130 }
1131
1132 /* Build up the log line for the message and main logs */
1133
1134 s = reset_point = store_get(size);
1135 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1136
1137 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1138 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1139
1140 /* Return path may not be set if no delivery actually happened */
1141
1142 if (used_return_path != NULL &&
1143 (log_extra_selector & LX_return_path_on_delivery) != 0)
1144 {
1145 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1146 }
1147
1148 if (addr->router != NULL)
1149 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1150 if (addr->transport != NULL)
1151 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1152
1153 if (addr->host_used != NULL)
1154 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
1155 US" [", addr->host_used->address, US"]");
1156
1157 if (addr->basic_errno > 0)
1158 s = string_append(s, &size, &ptr, 2, US": ",
1159 US strerror(addr->basic_errno));
1160
1161 if (addr->message != NULL)
1162 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1163
1164 s[ptr] = 0;
1165
1166 /* Do the logging. For the message log, "routing failed" for those cases,
1167 just to make it clearer. */
1168
1169 if (driver_name == NULL)
1170 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1171 else
1172 deliver_msglog("%s %s\n", now, s);
1173
1174 log_write(0, LOG_MAIN, "** %s", s);
1175 store_reset(reset_point);
1176 }
1177
1178/* Ensure logging is turned on again in all cases */
1179
1180disable_logging = FALSE;
1181}
1182
1183
1184
1185
1186/*************************************************
1187* Address-independent error *
1188*************************************************/
1189
1190/* This function is called when there's an error that is not dependent on a
1191particular address, such as an expansion string failure. It puts the error into
1192all the addresses in a batch, logs the incident on the main and panic logs, and
1193clears the expansions. It is mostly called from local_deliver(), but can be
1194called for a remote delivery via findugid().
1195
1196Arguments:
1197 logit TRUE if (MAIN+PANIC) logging required
1198 addr the first of the chain of addresses
1199 code the error code
1200 format format string for error message, or NULL if already set in addr
1201 ... arguments for the format
1202
1203Returns: nothing
1204*/
1205
1206static void
1207common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1208{
1209address_item *addr2;
1210addr->basic_errno = code;
1211
1212if (format != NULL)
1213 {
1214 va_list ap;
1215 uschar buffer[512];
1216 va_start(ap, format);
1217 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1218 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1219 "common_error expansion was longer than %d", sizeof(buffer));
1220 va_end(ap);
1221 addr->message = string_copy(buffer);
1222 }
1223
1224for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1225 {
1226 addr2->basic_errno = code;
1227 addr2->message = addr->message;
1228 }
1229
1230if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1231deliver_set_expansions(NULL);
1232}
1233
1234
1235
1236
1237/*************************************************
1238* Check a "never users" list *
1239*************************************************/
1240
1241/* This function is called to check whether a uid is on one of the two "never
1242users" lists.
1243
1244Arguments:
1245 uid the uid to be checked
1246 nusers the list to be scanned; the first item in the list is the count
1247
1248Returns: TRUE if the uid is on the list
1249*/
1250
1251static BOOL
1252check_never_users(uid_t uid, uid_t *nusers)
1253{
1254int i;
1255if (nusers == NULL) return FALSE;
1256for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1257return FALSE;
1258}
1259
1260
1261
1262/*************************************************
1263* Find uid and gid for a transport *
1264*************************************************/
1265
1266/* This function is called for both local and remote deliveries, to find the
1267uid/gid under which to run the delivery. The values are taken preferentially
1268from the transport (either explicit or deliver_as_creator), then from the
1269address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1270the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1271panic error is logged, and the function fails (which normally leads to delivery
1272deferral).
1273
1274Arguments:
1275 addr the address (possibly a chain)
1276 tp the transport
1277 uidp pointer to uid field
1278 gidp pointer to gid field
1279 igfp pointer to the use_initgroups field
1280
1281Returns: FALSE if failed - error has been set in address(es)
1282*/
1283
1284static BOOL
1285findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1286 BOOL *igfp)
1287{
1288uschar *nuname = NULL;
1289BOOL gid_set = FALSE;
1290
1291/* Default initgroups flag comes from the transport */
1292
1293*igfp = tp->initgroups;
1294
1295/* First see if there's a gid on the transport, either fixed or expandable.
1296The expanding function always logs failure itself. */
1297
1298if (tp->gid_set)
1299 {
1300 *gidp = tp->gid;
1301 gid_set = TRUE;
1302 }
1303else if (tp->expand_gid != NULL)
1304 {
1305 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1306 &(addr->message))) gid_set = TRUE;
1307 else
1308 {
1309 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1310 return FALSE;
1311 }
1312 }
1313
911f6fde
PH
1314/* If the transport did not set a group, see if the router did. */
1315
1316if (!gid_set && testflag(addr, af_gid_set))
1317 {
1318 *gidp = addr->gid;
1319 gid_set = TRUE;
1320 }
1321
059ec3d9
PH
1322/* Pick up a uid from the transport if one is set. */
1323
1324if (tp->uid_set) *uidp = tp->uid;
1325
1326/* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1327it does not provide a passwd value from which a gid can be taken. */
1328
1329else if (tp->expand_uid != NULL)
1330 {
1331 struct passwd *pw;
1332 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1333 uidp, &(addr->message)))
1334 {
1335 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1336 return FALSE;
1337 }
1338 if (!gid_set && pw != NULL)
1339 {
1340 *gidp = pw->pw_gid;
1341 gid_set = TRUE;
1342 }
1343 }
1344
1345/* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1346
1347else if (tp->deliver_as_creator)
1348 {
1349 *uidp = originator_uid;
1350 if (!gid_set)
1351 {
1352 *gidp = originator_gid;
1353 gid_set = TRUE;
1354 }
1355 }
1356
911f6fde
PH
1357/* Otherwise see if the address specifies the uid and if so, take it and its
1358initgroups flag. */
059ec3d9
PH
1359
1360else if (testflag(addr, af_uid_set))
1361 {
1362 *uidp = addr->uid;
1363 *igfp = testflag(addr, af_initgroups);
059ec3d9
PH
1364 }
1365
1366/* Nothing has specified the uid - default to the Exim user, and group if the
1367gid is not set. */
1368
1369else
1370 {
1371 *uidp = exim_uid;
1372 if (!gid_set)
1373 {
1374 *gidp = exim_gid;
1375 gid_set = TRUE;
1376 }
1377 }
1378
911f6fde
PH
1379/* If no gid is set, it is a disaster. We default to the Exim gid only if
1380defaulting to the Exim uid. In other words, if the configuration has specified
1381a uid, it must also provide a gid. */
059ec3d9
PH
1382
1383if (!gid_set)
1384 {
1385 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1386 "%s transport", tp->name);
1387 return FALSE;
1388 }
1389
1390/* Check that the uid is not on the lists of banned uids that may not be used
1391for delivery processes. */
1392
1393if (check_never_users(*uidp, never_users))
1394 nuname = US"never_users";
1395else if (check_never_users(*uidp, fixed_never_users))
1396 nuname = US"fixed_never_users";
1397
1398if (nuname != NULL)
1399 {
1400 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1401 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1402 return FALSE;
1403 }
1404
1405/* All is well */
1406
1407return TRUE;
1408}
1409
1410
1411
1412
1413/*************************************************
1414* Check the size of a message for a transport *
1415*************************************************/
1416
1417/* Checks that the message isn't too big for the selected transport.
1418This is called only when it is known that the limit is set.
1419
1420Arguments:
1421 tp the transport
1422 addr the (first) address being delivered
1423
1424Returns: OK
1425 DEFER expansion failed or did not yield an integer
1426 FAIL message too big
1427*/
1428
1429int
1430check_message_size(transport_instance *tp, address_item *addr)
1431{
1432int rc = OK;
1433int size_limit;
1434
1435deliver_set_expansions(addr);
d45b1de8 1436size_limit = expand_string_integer(tp->message_size_limit, TRUE);
059ec3d9
PH
1437deliver_set_expansions(NULL);
1438
d45b1de8 1439if (expand_string_message != NULL)
059ec3d9
PH
1440 {
1441 rc = DEFER;
1442 if (size_limit == -1)
1443 addr->message = string_sprintf("failed to expand message_size_limit "
1444 "in %s transport: %s", tp->name, expand_string_message);
1445 else
1446 addr->message = string_sprintf("invalid message_size_limit "
1447 "in %s transport: %s", tp->name, expand_string_message);
1448 }
1449else if (size_limit > 0 && message_size > size_limit)
1450 {
1451 rc = FAIL;
1452 addr->message =
1453 string_sprintf("message is too big (transport limit = %d)",
1454 size_limit);
1455 }
1456
1457return rc;
1458}
1459
1460
1461
1462/*************************************************
1463* Transport-time check for a previous delivery *
1464*************************************************/
1465
1466/* Check that this base address hasn't previously been delivered to its routed
c2c19e9d
PH
1467transport. If it has been delivered, mark it done. The check is necessary at
1468delivery time in order to handle homonymic addresses correctly in cases where
1469the pattern of redirection changes between delivery attempts (so the unique
1470fields change). Non-homonymic previous delivery is detected earlier, at routing
1471time (which saves unnecessary routing).
1472
1473Arguments:
1474 addr the address item
1475 testing TRUE if testing wanted only, without side effects
059ec3d9 1476
059ec3d9
PH
1477Returns: TRUE if previously delivered by the transport
1478*/
1479
1480static BOOL
c2c19e9d 1481previously_transported(address_item *addr, BOOL testing)
059ec3d9
PH
1482{
1483(void)string_format(big_buffer, big_buffer_size, "%s/%s",
1484 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1485
1486if (tree_search(tree_nonrecipients, big_buffer) != 0)
1487 {
1488 DEBUG(D_deliver|D_route|D_transport)
1489 debug_printf("%s was previously delivered (%s transport): discarded\n",
1490 addr->address, addr->transport->name);
c2c19e9d 1491 if (!testing) child_done(addr, tod_stamp(tod_log));
059ec3d9
PH
1492 return TRUE;
1493 }
1494
1495return FALSE;
1496}
1497
1498
1499
064a94c9
PH
1500/******************************************************
1501* Check for a given header in a header string *
1502******************************************************/
1503
1504/* This function is used when generating quota warnings. The configuration may
1505specify any header lines it likes in quota_warn_message. If certain of them are
1506missing, defaults are inserted, so we need to be able to test for the presence
1507of a given header.
1508
1509Arguments:
1510 hdr the required header name
1511 hstring the header string
1512
1513Returns: TRUE the header is in the string
1514 FALSE the header is not in the string
1515*/
1516
1517static BOOL
1518contains_header(uschar *hdr, uschar *hstring)
1519{
1520int len = Ustrlen(hdr);
1521uschar *p = hstring;
1522while (*p != 0)
1523 {
1524 if (strncmpic(p, hdr, len) == 0)
1525 {
1526 p += len;
1527 while (*p == ' ' || *p == '\t') p++;
1528 if (*p == ':') return TRUE;
1529 }
1530 while (*p != 0 && *p != '\n') p++;
1531 if (*p == '\n') p++;
1532 }
1533return FALSE;
1534}
1535
1536
1537
059ec3d9
PH
1538
1539/*************************************************
1540* Perform a local delivery *
1541*************************************************/
1542
1543/* Each local delivery is performed in a separate process which sets its
1544uid and gid as specified. This is a safer way than simply changing and
1545restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1546used safely. From release 4, Exim no longer makes any use of it. Besides, not
1547all systems have seteuid().
1548
1549If the uid/gid are specified in the transport_instance, they are used; the
1550transport initialization must ensure that either both or neither are set.
1551Otherwise, the values associated with the address are used. If neither are set,
1552it is a configuration error.
1553
1554The transport or the address may specify a home directory (transport over-
1555rides), and if they do, this is set as $home. If neither have set a working
1556directory, this value is used for that as well. Otherwise $home is left unset
1557and the cwd is set to "/" - a directory that should be accessible to all users.
1558
1559Using a separate process makes it more complicated to get error information
1560back. We use a pipe to pass the return code and also an error code and error
1561text string back to the parent process.
1562
1563Arguments:
1564 addr points to an address block for this delivery; for "normal" local
1565 deliveries this is the only address to be delivered, but for
1566 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1567 a number of addresses can be handled simultaneously, and in this
1568 case addr will point to a chain of addresses with the same
1569 characteristics.
1570
1571 shadowing TRUE if running a shadow transport; this causes output from pipes
1572 to be ignored.
1573
1574Returns: nothing
1575*/
1576
1577static void
1578deliver_local(address_item *addr, BOOL shadowing)
1579{
1580BOOL use_initgroups;
1581uid_t uid;
1582gid_t gid;
1583int status, len, rc;
1584int pfd[2];
1585pid_t pid;
1586uschar *working_directory;
1587address_item *addr2;
1588transport_instance *tp = addr->transport;
1589
1590/* Set up the return path from the errors or sender address. If the transport
1591has its own return path setting, expand it and replace the existing value. */
1592
384152a6
TK
1593if(addr->p.errors_address != NULL)
1594 return_path = addr->p.errors_address;
1595#ifdef EXPERIMENTAL_SRS
1596else if(addr->p.srs_sender != NULL)
1597 return_path = addr->p.srs_sender;
1598#endif
1599else
1600 return_path = sender_address;
059ec3d9
PH
1601
1602if (tp->return_path != NULL)
1603 {
1604 uschar *new_return_path = expand_string(tp->return_path);
1605 if (new_return_path == NULL)
1606 {
1607 if (!expand_string_forcedfail)
1608 {
1609 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1610 US"Failed to expand return path \"%s\" in %s transport: %s",
1611 tp->return_path, tp->name, expand_string_message);
1612 return;
1613 }
1614 }
1615 else return_path = new_return_path;
1616 }
1617
1618/* For local deliveries, one at a time, the value used for logging can just be
1619set directly, once and for all. */
1620
1621used_return_path = return_path;
1622
1623/* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1624gets put into the address(es), and the expansions are unset, so we can just
1625return. */
1626
1627if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1628
5418e93b
PH
1629/* See if either the transport or the address specifies a home directory. A
1630home directory set in the address may already be expanded; a flag is set to
1631indicate that. In other cases we must expand it. */
059ec3d9 1632
5418e93b
PH
1633if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1634 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1635 !testflag(addr, af_home_expanded))) /* not expanded */
059ec3d9
PH
1636 {
1637 uschar *rawhome = deliver_home;
1638 deliver_home = NULL; /* in case it contains $home */
1639 deliver_home = expand_string(rawhome);
1640 if (deliver_home == NULL)
1641 {
1642 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1643 "to expand for %s transport: %s", rawhome, tp->name,
1644 expand_string_message);
1645 return;
1646 }
1647 if (*deliver_home != '/')
1648 {
1649 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1650 "is not absolute for %s transport", deliver_home, tp->name);
1651 return;
1652 }
1653 }
1654
5418e93b
PH
1655/* See if either the transport or the address specifies a current directory,
1656and if so, expand it. If nothing is set, use the home directory, unless it is
1657also unset in which case use "/", which is assumed to be a directory to which
1658all users have access. It is necessary to be in a visible directory for some
1659operating systems when running pipes, as some commands (e.g. "rm" under Solaris
16602.5) require this. */
1661
1662working_directory = (tp->current_dir != NULL)?
1663 tp->current_dir : addr->current_dir;
059ec3d9
PH
1664
1665if (working_directory != NULL)
1666 {
1667 uschar *raw = working_directory;
1668 working_directory = expand_string(raw);
1669 if (working_directory == NULL)
1670 {
1671 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1672 "failed to expand for %s transport: %s", raw, tp->name,
1673 expand_string_message);
1674 return;
1675 }
1676 if (*working_directory != '/')
1677 {
1678 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1679 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1680 return;
1681 }
1682 }
1683else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1684
1685/* If one of the return_output flags is set on the transport, create and open a
1686file in the message log directory for the transport to write its output onto.
1687This is mainly used by pipe transports. The file needs to be unique to the
1688address. This feature is not available for shadow transports. */
1689
1690if (!shadowing && (tp->return_output || tp->return_fail_output ||
1691 tp->log_output || tp->log_fail_output))
1692 {
1693 uschar *error;
1694 addr->return_filename =
1695 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1696 message_id, getpid(), return_count++);
1697 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1698 if (addr->return_file < 0)
1699 {
1700 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1701 "to return message: %s", error, tp->name, strerror(errno));
1702 return;
1703 }
1704 }
1705
1706/* Create the pipe for inter-process communication. */
1707
1708if (pipe(pfd) != 0)
1709 {
1710 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1711 strerror(errno));
1712 return;
1713 }
1714
1715/* Now fork the process to do the real work in the subprocess, but first
1716ensure that all cached resources are freed so that the subprocess starts with
1717a clean slate and doesn't interfere with the parent process. */
1718
1719search_tidyup();
1720
1721if ((pid = fork()) == 0)
1722 {
1723 BOOL replicate = TRUE;
1724
1725 /* Prevent core dumps, as we don't want them in users' home directories.
1726 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1727 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1728 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1729 complain if the error is "not supported". */
1730
1731 #ifdef RLIMIT_CORE
1732 struct rlimit rl;
1733 rl.rlim_cur = 0;
1734 rl.rlim_max = 0;
1735 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1736 {
1737 #ifdef SETRLIMIT_NOT_SUPPORTED
1738 if (errno != ENOSYS && errno != ENOTSUP)
1739 #endif
1740 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1741 strerror(errno));
1742 }
1743 #endif
1744
1745 /* Reset the random number generator, so different processes don't all
1746 have the same sequence. */
1747
1748 random_seed = 0;
1749
1750 /* If the transport has a setup entry, call this first, while still
1751 privileged. (Appendfile uses this to expand quota, for example, while
1752 able to read private files.) */
1753
1754 if (addr->transport->setup != NULL)
1755 {
929ba01c 1756 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
059ec3d9
PH
1757 &(addr->message)))
1758 {
1759 case DEFER:
1760 addr->transport_return = DEFER;
1761 goto PASS_BACK;
1762
1763 case FAIL:
1764 addr->transport_return = PANIC;
1765 goto PASS_BACK;
1766 }
1767 }
1768
1769 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1770 when the process becomes unprivileged, it won't be able to write to the
1771 process log. SIGHUP is ignored throughout exim, except when it is being
1772 run as a daemon. */
1773
1774 signal(SIGINT, SIG_IGN);
1775 signal(SIGTERM, SIG_IGN);
1776 signal(SIGUSR1, SIG_IGN);
1777
1778 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1779 half - for transports that exec things (e.g. pipe). Then set the required
1780 gid/uid. */
1781
f1e894f3 1782 (void)close(pfd[pipe_read]);
ff790e47 1783 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
059ec3d9
PH
1784 FD_CLOEXEC);
1785 exim_setugid(uid, gid, use_initgroups,
1786 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1787 addr->address, addr->transport->name));
1788
1789 DEBUG(D_deliver)
1790 {
1791 address_item *batched;
1792 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1793 for (batched = addr->next; batched != NULL; batched = batched->next)
1794 debug_printf("additional batched address: %s\n", batched->address);
1795 }
1796
1797 /* Set an appropriate working directory. */
1798
1799 if (Uchdir(working_directory) < 0)
1800 {
1801 addr->transport_return = DEFER;
1802 addr->basic_errno = errno;
1803 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1804 }
1805
1806 /* If successful, call the transport */
1807
1808 else
1809 {
1810 BOOL ok = TRUE;
1811 set_process_info("delivering %s to %s using %s", message_id,
1812 addr->local_part, addr->transport->name);
1813
1814 /* If a transport filter has been specified, set up its argument list.
1815 Any errors will get put into the address, and FALSE yielded. */
1816
1817 if (addr->transport->filter_command != NULL)
1818 {
1819 ok = transport_set_up_command(&transport_filter_argv,
1820 addr->transport->filter_command,
1821 TRUE, PANIC, addr, US"transport filter", NULL);
1822 transport_filter_timeout = addr->transport->filter_timeout;
1823 }
1824 else transport_filter_argv = NULL;
1825
1826 if (ok)
1827 {
1828 debug_print_string(addr->transport->debug_string);
1829 replicate = !(addr->transport->info->code)(addr->transport, addr);
1830 }
1831 }
1832
1833 /* Pass the results back down the pipe. If necessary, first replicate the
1834 status in the top address to the others in the batch. The label is the
1835 subject of a goto when a call to the transport's setup function fails. We
1836 pass the pointer to the transport back in case it got changed as a result of
1837 file_format in appendfile. */
1838
1839 PASS_BACK:
1840
1841 if (replicate) replicate_status(addr);
1842 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1843 {
1844 int i;
1845 int local_part_length = Ustrlen(addr2->local_part);
1846 uschar *s;
1847
f1e894f3
PH
1848 (void)write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int));
1849 (void)write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count));
1850 (void)write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags));
1851 (void)write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int));
1852 (void)write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int));
1853 (void)write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int));
1854 (void)write(pfd[pipe_write], (void *)&(addr2->transport),
059ec3d9
PH
1855 sizeof(transport_instance *));
1856
1857 /* For a file delivery, pass back the local part, in case the original
1858 was only part of the final delivery path. This gives more complete
1859 logging. */
1860
1861 if (testflag(addr2, af_file))
1862 {
f1e894f3
PH
1863 (void)write(pfd[pipe_write], (void *)&local_part_length, sizeof(int));
1864 (void)write(pfd[pipe_write], addr2->local_part, local_part_length);
059ec3d9
PH
1865 }
1866
1867 /* Now any messages */
1868
1869 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
1870 {
1871 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
f1e894f3
PH
1872 (void)write(pfd[pipe_write], (void *)&message_length, sizeof(int));
1873 if (message_length > 0) (void)write(pfd[pipe_write], s, message_length);
059ec3d9
PH
1874 }
1875 }
1876
1877 /* OK, this process is now done. Free any cached resources that it opened,
1878 and close the pipe we were writing down before exiting. */
1879
f1e894f3 1880 (void)close(pfd[pipe_write]);
059ec3d9
PH
1881 search_tidyup();
1882 exit(EXIT_SUCCESS);
1883 }
1884
1885/* Back in the main process: panic if the fork did not succeed. This seems
1886better than returning an error - if forking is failing it is probably best
1887not to try other deliveries for this message. */
1888
1889if (pid < 0)
1890 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
1891 addr->address);
1892
1893/* Read the pipe to get the delivery status codes and error messages. Our copy
1894of the writing end must be closed first, as otherwise read() won't return zero
1895on an empty pipe. We check that a status exists for each address before
1896overwriting the address structure. If data is missing, the default DEFER status
1897will remain. Afterwards, close the reading end. */
1898
f1e894f3 1899(void)close(pfd[pipe_write]);
059ec3d9
PH
1900
1901for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1902 {
1903 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
1904 if (len > 0)
1905 {
1906 int i;
1907 uschar **sptr;
1908
1909 addr2->transport_return = status;
1910 len = read(pfd[pipe_read], (void *)&transport_count,
1911 sizeof(transport_count));
1912 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
1913 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
1914 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
1915 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
1916 len = read(pfd[pipe_read], (void *)&(addr2->transport),
1917 sizeof(transport_instance *));
1918
1919 if (testflag(addr2, af_file))
1920 {
1921 int local_part_length;
1922 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
1923 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
1924 big_buffer[local_part_length] = 0;
1925 addr2->local_part = string_copy(big_buffer);
1926 }
1927
1928 for (i = 0, sptr = &(addr2->message); i < 2;
1929 i++, sptr = &(addr2->user_message))
1930 {
1931 int message_length;
1932 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
1933 if (message_length > 0)
1934 {
1935 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
1936 if (len > 0) *sptr = string_copy(big_buffer);
1937 }
1938 }
1939 }
1940
1941 else
1942 {
1943 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
1944 "from delivery subprocess", addr2->unique);
1945 break;
1946 }
1947 }
1948
f1e894f3 1949(void)close(pfd[pipe_read]);
059ec3d9
PH
1950
1951/* Unless shadowing, write all successful addresses immediately to the journal
1952file, to ensure they are recorded asap. For homonymic addresses, use the base
1953address plus the transport name. Failure to write the journal is panic-worthy,
1954but don't stop, as it may prove possible subsequently to update the spool file
1955in order to record the delivery. */
1956
1957if (!shadowing)
1958 {
1959 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1960 {
1961 if (addr2->transport_return != OK) continue;
1962
1963 if (testflag(addr2, af_homonym))
1964 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
1965 else
1966 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
1967
1968 /* In the test harness, wait just a bit to let the subprocess finish off
1969 any debug output etc first. */
1970
1971 if (running_in_test_harness) millisleep(300);
1972
1973 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
1974 len = Ustrlen(big_buffer);
1975 if (write(journal_fd, big_buffer, len) != len)
1976 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
1977 big_buffer, strerror(errno));
1978 }
1979
1980 /* Ensure the journal file is pushed out to disk. */
1981
1982 if (fsync(journal_fd) < 0)
1983 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
1984 strerror(errno));
1985 }
1986
1987/* Wait for the process to finish. If it terminates with a non-zero code,
1988freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
1989status values of all the addresses as they are. Take care to handle the case
1990when the subprocess doesn't seem to exist. This has been seen on one system
1991when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
1992happens, wait() doesn't recognize the termination of child processes. Exim now
1993resets SIGCHLD to SIG_DFL, but this code should still be robust. */
1994
1995while ((rc = wait(&status)) != pid)
1996 {
1997 if (rc < 0 && errno == ECHILD) /* Process has vanished */
1998 {
1999 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2000 addr->transport->driver_name);
2001 status = 0;
2002 break;
2003 }
2004 }
2005
2006if ((status & 0xffff) != 0)
2007 {
2008 int msb = (status >> 8) & 255;
2009 int lsb = status & 255;
2010 int code = (msb == 0)? (lsb & 0x7f) : msb;
2011 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2012 addr->special_action = SPECIAL_FREEZE;
2013 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2014 "status 0x%04x: %s %d",
2015 addr->transport->driver_name,
2016 status,
2017 (msb == 0)? "terminated by signal" : "exit code",
2018 code);
2019 }
2020
2021/* If SPECIAL_WARN is set in the top address, send a warning message. */
2022
2023if (addr->special_action == SPECIAL_WARN &&
2024 addr->transport->warn_message != NULL)
2025 {
2026 int fd;
2027 uschar *warn_message;
2028
2029 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2030
2031 warn_message = expand_string(addr->transport->warn_message);
2032 if (warn_message == NULL)
2033 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2034 "message for %s transport): %s", addr->transport->warn_message,
2035 addr->transport->name, expand_string_message);
2036 else
2037 {
2038 pid_t pid = child_open_exim(&fd);
2039 if (pid > 0)
2040 {
2041 FILE *f = fdopen(fd, "wb");
064a94c9
PH
2042 if (errors_reply_to != NULL &&
2043 !contains_header(US"Reply-To", warn_message))
059ec3d9 2044 fprintf(f, "Reply-To: %s\n", errors_reply_to);
456682f5 2045 fprintf(f, "Auto-Submitted: auto-replied\n");
064a94c9
PH
2046 if (!contains_header(US"From", warn_message))
2047 fprintf(f, "From: Mail Delivery System <Mailer-Daemon@%s>\n",
2048 qualify_domain_sender);
059ec3d9
PH
2049 fprintf(f, "%s", CS warn_message);
2050
2051 /* Close and wait for child process to complete, without a timeout. */
2052
f1e894f3 2053 (void)fclose(f);
059ec3d9
PH
2054 (void)child_close(pid, 0);
2055 }
2056 }
2057
2058 addr->special_action = SPECIAL_NONE;
2059 }
2060}
2061
2062
2063
2064/*************************************************
2065* Do local deliveries *
2066*************************************************/
2067
2068/* This function processes the list of addresses in addr_local. True local
2069deliveries are always done one address at a time. However, local deliveries can
2070be batched up in some cases. Typically this is when writing batched SMTP output
2071files for use by some external transport mechanism, or when running local
2072deliveries over LMTP.
2073
2074Arguments: None
2075Returns: Nothing
2076*/
2077
2078static void
2079do_local_deliveries(void)
2080{
2081open_db dbblock;
2082open_db *dbm_file = NULL;
2083time_t now = time(NULL);
2084
2085/* Loop until we have exhausted the supply of local deliveries */
2086
2087while (addr_local != NULL)
2088 {
2089 time_t delivery_start;
2090 int deliver_time;
2091 address_item *addr2, *addr3, *nextaddr;
2092 int logflags = LOG_MAIN;
2093 int logchar = dont_deliver? '*' : '=';
2094 transport_instance *tp;
2095
2096 /* Pick the first undelivered address off the chain */
2097
2098 address_item *addr = addr_local;
2099 addr_local = addr->next;
2100 addr->next = NULL;
2101
2102 DEBUG(D_deliver|D_transport)
2103 debug_printf("--------> %s <--------\n", addr->address);
2104
2105 /* An internal disaster if there is no transport. Should not occur! */
2106
2107 if ((tp = addr->transport) == NULL)
2108 {
2109 logflags |= LOG_PANIC;
2110 disable_logging = FALSE; /* Jic */
2111 addr->message =
2112 (addr->router != NULL)?
2113 string_sprintf("No transport set by %s router", addr->router->name)
2114 :
2115 string_sprintf("No transport set by system filter");
2116 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2117 continue;
2118 }
2119
2120 /* Check that this base address hasn't previously been delivered to this
2121 transport. The check is necessary at this point to handle homonymic addresses
2122 correctly in cases where the pattern of redirection changes between delivery
2123 attempts. Non-homonymic previous delivery is detected earlier, at routing
2124 time. */
2125
c2c19e9d 2126 if (previously_transported(addr, FALSE)) continue;
059ec3d9
PH
2127
2128 /* There are weird cases where logging is disabled */
2129
2130 disable_logging = tp->disable_logging;
2131
f7fd3850
PH
2132 /* Check for batched addresses and possible amalgamation. Skip all the work
2133 if either batch_max <= 1 or there aren't any other addresses for local
2134 delivery. */
059ec3d9 2135
f7fd3850 2136 if (tp->batch_max > 1 && addr_local != NULL)
059ec3d9
PH
2137 {
2138 int batch_count = 1;
2139 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
f7fd3850
PH
2140 BOOL uses_lp = (testflag(addr, af_pfr) &&
2141 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2142 readconf_depends((driver_instance *)tp, US"local_part");
059ec3d9
PH
2143 uschar *batch_id = NULL;
2144 address_item **anchor = &addr_local;
2145 address_item *last = addr;
2146 address_item *next;
2147
2148 /* Expand the batch_id string for comparison with other addresses.
2149 Expansion failure suppresses batching. */
2150
2151 if (tp->batch_id != NULL)
2152 {
2153 deliver_set_expansions(addr);
2154 batch_id = expand_string(tp->batch_id);
2155 deliver_set_expansions(NULL);
2156 if (batch_id == NULL)
2157 {
2158 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2159 "in %s transport (%s): %s", tp->name, addr->address,
2160 expand_string_message);
2161 batch_count = tp->batch_max;
2162 }
2163 }
2164
2165 /* Until we reach the batch_max limit, pick off addresses which have the
2166 same characteristics. These are:
2167
2168 same transport
7816e254 2169 not previously delivered (see comment about 50 lines above)
059ec3d9 2170 same local part if the transport's configuration contains $local_part
f7fd3850 2171 or if this is a file or pipe delivery from a redirection
059ec3d9
PH
2172 same domain if the transport's configuration contains $domain
2173 same errors address
2174 same additional headers
2175 same headers to be removed
2176 same uid/gid for running the transport
2177 same first host if a host list is set
2178 */
2179
2180 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2181 {
2182 BOOL ok =
2183 tp == next->transport &&
c2c19e9d 2184 !previously_transported(next, TRUE) &&
f7fd3850 2185 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
059ec3d9
PH
2186 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2187 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2188 same_strings(next->p.errors_address, addr->p.errors_address) &&
2189 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2190 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2191 same_ugid(tp, addr, next) &&
2192 ((addr->host_list == NULL && next->host_list == NULL) ||
2193 (addr->host_list != NULL && next->host_list != NULL &&
2194 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2195
2196 /* If the transport has a batch_id setting, batch_id will be non-NULL
2197 from the expansion outside the loop. Expand for this address and compare.
2198 Expansion failure makes this address ineligible for batching. */
2199
2200 if (ok && batch_id != NULL)
2201 {
2202 uschar *bid;
2203 address_item *save_nextnext = next->next;
2204 next->next = NULL; /* Expansion for a single address */
2205 deliver_set_expansions(next);
2206 next->next = save_nextnext;
2207 bid = expand_string(tp->batch_id);
2208 deliver_set_expansions(NULL);
2209 if (bid == NULL)
2210 {
2211 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2212 "in %s transport (%s): %s", tp->name, next->address,
2213 expand_string_message);
2214 ok = FALSE;
2215 }
2216 else ok = (Ustrcmp(batch_id, bid) == 0);
2217 }
2218
2219 /* Take address into batch if OK. */
2220
2221 if (ok)
2222 {
2223 *anchor = next->next; /* Include the address */
2224 next->next = NULL;
2225 last->next = next;
2226 last = next;
2227 batch_count++;
2228 }
2229 else anchor = &(next->next); /* Skip the address */
2230 }
2231 }
2232
2233 /* We now have one or more addresses that can be delivered in a batch. Check
2234 whether the transport is prepared to accept a message of this size. If not,
2235 fail them all forthwith. If the expansion fails, or does not yield an
2236 integer, defer delivery. */
2237
2238 if (tp->message_size_limit != NULL)
2239 {
2240 int rc = check_message_size(tp, addr);
2241 if (rc != OK)
2242 {
2243 replicate_status(addr);
2244 while (addr != NULL)
2245 {
2246 addr2 = addr->next;
2247 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2248 addr = addr2;
2249 }
2250 continue; /* With next batch of addresses */
2251 }
2252 }
2253
2254 /* If we are not running the queue, or if forcing, all deliveries will be
2255 attempted. Otherwise, we must respect the retry times for each address. Even
2256 when not doing this, we need to set up the retry key string, and determine
2257 whether a retry record exists, because after a successful delivery, a delete
2258 retry item must be set up. Keep the retry database open only for the duration
2259 of these checks, rather than for all local deliveries, because some local
2260 deliveries (e.g. to pipes) can take a substantial time. */
2261
2262 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2263 if (dbm_file == NULL)
2264 {
2265 DEBUG(D_deliver|D_retry|D_hints_lookup)
2266 debug_printf("no retry data available\n");
2267 }
2268
2269 addr2 = addr;
2270 addr3 = NULL;
2271 while (addr2 != NULL)
2272 {
2273 BOOL ok = TRUE; /* to deliver this address */
2274 uschar *retry_key;
2275
2276 /* Set up the retry key to include the domain or not, and change its
2277 leading character from "R" to "T". Must make a copy before doing this,
2278 because the old key may be pointed to from a "delete" retry item after
2279 a routing delay. */
2280
2281 retry_key = string_copy(
2282 (tp->retry_use_local_part)? addr2->address_retry_key :
2283 addr2->domain_retry_key);
2284 *retry_key = 'T';
2285
2286 /* Inspect the retry data. If there is no hints file, delivery happens. */
2287
2288 if (dbm_file != NULL)
2289 {
2290 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2291
2292 /* If there is no retry record, delivery happens. If there is,
2293 remember it exists so it can be deleted after a successful delivery. */
2294
2295 if (retry_record != NULL)
2296 {
2297 setflag(addr2, af_lt_retry_exists);
2298
2299 /* A retry record exists for this address. If queue running and not
2300 forcing, inspect its contents. If the record is too old, or if its
2301 retry time has come, or if it has passed its cutoff time, delivery
2302 will go ahead. */
2303
2304 DEBUG(D_retry)
2305 {
ea49d0e1
PH
2306 debug_printf("retry record exists: age=%s ",
2307 readconf_printtime(now - retry_record->time_stamp));
2308 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2309 debug_printf(" time to retry = %s expired = %d\n",
2310 readconf_printtime(retry_record->next_try - now),
2311 retry_record->expired);
059ec3d9
PH
2312 }
2313
2314 if (queue_running && !deliver_force)
2315 {
2316 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2317 (now >= retry_record->next_try) ||
2318 retry_record->expired;
2319
2320 /* If we haven't reached the retry time, there is one more check
2321 to do, which is for the ultimate address timeout. */
2322
2323 if (!ok)
2324 {
2325 retry_config *retry =
2326 retry_find_config(retry_key+2, addr2->domain,
2327 retry_record->basic_errno,
2328 retry_record->more_errno);
2329
2330 DEBUG(D_deliver|D_retry)
148e1ac6 2331 {
059ec3d9
PH
2332 debug_printf("retry time not reached for %s: "
2333 "checking ultimate address timeout\n", addr2->address);
148e1ac6
PH
2334 debug_printf(" now=%d first_failed=%d next_try=%d expired=%d\n",
2335 (int)now, (int)retry_record->first_failed,
2336 (int)retry_record->next_try, retry_record->expired);
2337 }
059ec3d9
PH
2338
2339 if (retry != NULL && retry->rules != NULL)
2340 {
2341 retry_rule *last_rule;
2342 for (last_rule = retry->rules;
2343 last_rule->next != NULL;
2344 last_rule = last_rule->next);
ea49d0e1 2345 DEBUG(D_deliver|D_retry)
148e1ac6
PH
2346 debug_printf(" received_time=%d diff=%d timeout=%d\n",
2347 received_time, (int)now - received_time, last_rule->timeout);
059ec3d9
PH
2348 if (now - received_time > last_rule->timeout) ok = TRUE;
2349 }
ea49d0e1
PH
2350 else
2351 {
2352 DEBUG(D_deliver|D_retry)
2353 debug_printf("no retry rule found: assume timed out\n");
2354 ok = TRUE; /* No rule => timed out */
2355 }
059ec3d9
PH
2356
2357 DEBUG(D_deliver|D_retry)
2358 {
2359 if (ok) debug_printf("on queue longer than maximum retry for "
2360 "address - allowing delivery\n");
2361 }
2362 }
2363 }
2364 }
2365 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2366 }
2367
2368 /* This address is to be delivered. Leave it on the chain. */
2369
2370 if (ok)
2371 {
2372 addr3 = addr2;
2373 addr2 = addr2->next;
2374 }
2375
2376 /* This address is to be deferred. Take it out of the chain, and
2377 post-process it as complete. Must take it out of the chain first,
2378 because post processing puts it on another chain. */
2379
2380 else
2381 {
2382 address_item *this = addr2;
2383 this->message = US"Retry time not yet reached";
2384 this->basic_errno = ERRNO_LRETRY;
2385 if (addr3 == NULL) addr2 = addr = addr2->next;
2386 else addr2 = addr3->next = addr2->next;
2387 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2388 }
2389 }
2390
2391 if (dbm_file != NULL) dbfn_close(dbm_file);
2392
2393 /* If there are no addresses left on the chain, they all deferred. Loop
2394 for the next set of addresses. */
2395
2396 if (addr == NULL) continue;
2397
2398 /* So, finally, we do have some addresses that can be passed to the
2399 transport. Before doing so, set up variables that are relevant to a
2400 single delivery. */
2401
2402 deliver_set_expansions(addr);
2403 delivery_start = time(NULL);
2404 deliver_local(addr, FALSE);
2405 deliver_time = (int)(time(NULL) - delivery_start);
2406
2407 /* If a shadow transport (which must perforce be another local transport), is
2408 defined, and its condition is met, we must pass the message to the shadow
2409 too, but only those addresses that succeeded. We do this by making a new
2410 chain of addresses - also to keep the original chain uncontaminated. We must
2411 use a chain rather than doing it one by one, because the shadow transport may
2412 batch.
2413
2414 NOTE: if the condition fails because of a lookup defer, there is nothing we
2415 can do! */
2416
2417 if (tp->shadow != NULL &&
2418 (tp->shadow_condition == NULL ||
2419 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2420 {
2421 transport_instance *stp;
2422 address_item *shadow_addr = NULL;
2423 address_item **last = &shadow_addr;
2424
2425 for (stp = transports; stp != NULL; stp = stp->next)
2426 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2427
2428 if (stp == NULL)
2429 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2430 tp->shadow);
2431
2432 /* Pick off the addresses that have succeeded, and make clones. Put into
2433 the shadow_message field a pointer to the shadow_message field of the real
2434 address. */
2435
2436 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2437 {
2438 if (addr2->transport_return != OK) continue;
2439 addr3 = store_get(sizeof(address_item));
2440 *addr3 = *addr2;
2441 addr3->next = NULL;
2442 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2443 addr3->transport = stp;
2444 addr3->transport_return = DEFER;
2445 addr3->return_filename = NULL;
2446 addr3->return_file = -1;
2447 *last = addr3;
2448 last = &(addr3->next);
2449 }
2450
2451 /* If we found any addresses to shadow, run the delivery, and stick any
2452 message back into the shadow_message field in the original. */
2453
2454 if (shadow_addr != NULL)
2455 {
2456 int save_count = transport_count;
2457
2458 DEBUG(D_deliver|D_transport)
2459 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2460 deliver_local(shadow_addr, TRUE);
2461
2462 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2463 {
2464 int sresult = shadow_addr->transport_return;
2465 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2466 string_sprintf(" ST=%s", stp->name) :
2467 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2468 (shadow_addr->basic_errno <= 0)?
2469 US"" : US strerror(shadow_addr->basic_errno),
2470 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2471 US"" : US": ",
2472 (shadow_addr->message != NULL)? shadow_addr->message :
2473 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2474
2475 DEBUG(D_deliver|D_transport)
2476 debug_printf("%s shadow transport returned %s for %s\n",
2477 stp->name,
2478 (sresult == OK)? "OK" :
2479 (sresult == DEFER)? "DEFER" :
2480 (sresult == FAIL)? "FAIL" :
2481 (sresult == PANIC)? "PANIC" : "?",
2482 shadow_addr->address);
2483 }
2484
2485 DEBUG(D_deliver|D_transport)
2486 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2487
2488 transport_count = save_count; /* Restore original transport count */
2489 }
2490 }
2491
2492 /* Cancel the expansions that were set up for the delivery. */
2493
2494 deliver_set_expansions(NULL);
2495
2496 /* Now we can process the results of the real transport. We must take each
2497 address off the chain first, because post_process_one() puts it on another
2498 chain. */
2499
2500 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2501 {
2502 int result = addr2->transport_return;
2503 nextaddr = addr2->next;
2504
2505 DEBUG(D_deliver|D_transport)
2506 debug_printf("%s transport returned %s for %s\n",
2507 tp->name,
2508 (result == OK)? "OK" :
2509 (result == DEFER)? "DEFER" :
2510 (result == FAIL)? "FAIL" :
2511 (result == PANIC)? "PANIC" : "?",
2512 addr2->address);
2513
2514 /* If there is a retry_record, or if delivery is deferred, build a retry
2515 item for setting a new retry time or deleting the old retry record from
2516 the database. These items are handled all together after all addresses
2517 have been handled (so the database is open just for a short time for
2518 updating). */
2519
2520 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2521 {
2522 int flags = (result == DEFER)? 0 : rf_delete;
2523 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2524 addr2->address_retry_key : addr2->domain_retry_key);
2525 *retry_key = 'T';
2526 retry_add_item(addr2, retry_key, flags);
2527 }
2528
2529 /* Done with this address */
2530
2531 if (result == OK) addr2->more_errno = deliver_time;
2532 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2533
2534 /* If a pipe delivery generated text to be sent back, the result may be
2535 changed to FAIL, and we must copy this for subsequent addresses in the
2536 batch. */
2537
2538 if (addr2->transport_return != result)
2539 {
2540 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2541 {
2542 addr3->transport_return = addr2->transport_return;
2543 addr3->basic_errno = addr2->basic_errno;
2544 addr3->message = addr2->message;
2545 }
2546 result = addr2->transport_return;
2547 }
2548
2549 /* Whether or not the result was changed to FAIL, we need to copy the
2550 return_file value from the first address into all the addresses of the
2551 batch, so they are all listed in the error message. */
2552
2553 addr2->return_file = addr->return_file;
2554
2555 /* Change log character for recording successful deliveries. */
2556
2557 if (result == OK) logchar = '-';
2558 }
2559 } /* Loop back for next batch of addresses */
2560}
2561
2562
2563
2564
2565/*************************************************
2566* Sort remote deliveries *
2567*************************************************/
2568
2569/* This function is called if remote_sort_domains is set. It arranges that the
2570chain of addresses for remote deliveries is ordered according to the strings
2571specified. Try to make this shuffling reasonably efficient by handling
2572sequences of addresses rather than just single ones.
2573
2574Arguments: None
2575Returns: Nothing
2576*/
2577
2578static void
2579sort_remote_deliveries(void)
2580{
2581int sep = 0;
2582address_item **aptr = &addr_remote;
2583uschar *listptr = remote_sort_domains;
2584uschar *pattern;
2585uschar patbuf[256];
2586
2587while (*aptr != NULL &&
2588 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2589 != NULL)
2590 {
2591 address_item *moved = NULL;
2592 address_item **bptr = &moved;
2593
2594 while (*aptr != NULL)
2595 {
2596 address_item **next;
2597 deliver_domain = (*aptr)->domain; /* set $domain */
2598 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2599 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2600 {
2601 aptr = &((*aptr)->next);
2602 continue;
2603 }
2604
2605 next = &((*aptr)->next);
2606 while (*next != NULL &&
2607 (deliver_domain = (*next)->domain, /* Set $domain */
2608 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2609 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2610 next = &((*next)->next);
2611
2612 /* If the batch of non-matchers is at the end, add on any that were
2613 extracted further up the chain, and end this iteration. Otherwise,
2614 extract them from the chain and hang on the moved chain. */
2615
2616 if (*next == NULL)
2617 {
2618 *next = moved;
2619 break;
2620 }
2621
2622 *bptr = *aptr;
2623 *aptr = *next;
2624 *next = NULL;
2625 bptr = next;
2626 aptr = &((*aptr)->next);
2627 }
2628
2629 /* If the loop ended because the final address matched, *aptr will
2630 be NULL. Add on to the end any extracted non-matching addresses. If
2631 *aptr is not NULL, the loop ended via "break" when *next is null, that
2632 is, there was a string of non-matching addresses at the end. In this
2633 case the extracted addresses have already been added on the end. */
2634
2635 if (*aptr == NULL) *aptr = moved;
2636 }
2637
2638DEBUG(D_deliver)
2639 {
2640 address_item *addr;
2641 debug_printf("remote addresses after sorting:\n");
2642 for (addr = addr_remote; addr != NULL; addr = addr->next)
2643 debug_printf(" %s\n", addr->address);
2644 }
2645}
2646
2647
2648
2649/*************************************************
2650* Read from pipe for remote delivery subprocess *
2651*************************************************/
2652
2653/* This function is called when the subprocess is complete, but can also be
2654called before it is complete, in order to empty a pipe that is full (to prevent
2655deadlock). It must therefore keep track of its progress in the parlist data
2656block.
2657
2658We read the pipe to get the delivery status codes and a possible error message
2659for each address, optionally preceded by unusability data for the hosts and
2660also by optional retry data.
2661
2662Read in large chunks into the big buffer and then scan through, interpreting
2663the data therein. In most cases, only a single read will be necessary. No
1c5466b9
PH
2664individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2665that we read the next chunk when there is less than 2500 bytes left in the
2666non-final chunk, we can assume each item is complete in the buffer before
2667handling it. Each item is written using a single write(), which is atomic for
2668small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2669often bigger) so even if we are reading while the subprocess is still going, we
2670should never have only a partial item in the buffer.
059ec3d9
PH
2671
2672Argument:
2673 poffset the offset of the parlist item
2674 eop TRUE if the process has completed
2675
2676Returns: TRUE if the terminating 'Z' item has been read,
2677 or there has been a disaster (i.e. no more data needed);
2678 FALSE otherwise
2679*/
2680
2681static BOOL
2682par_read_pipe(int poffset, BOOL eop)
2683{
2684host_item *h;
2685pardata *p = parlist + poffset;
2686address_item *addrlist = p->addrlist;
2687address_item *addr = p->addr;
2688pid_t pid = p->pid;
2689int fd = p->fd;
2690uschar *endptr = big_buffer;
2691uschar *ptr = endptr;
2692uschar *msg = p->msg;
2693BOOL done = p->done;
2694BOOL unfinished = TRUE;
2695
2696/* Loop through all items, reading from the pipe when necessary. The pipe
2697is set up to be non-blocking, but there are two different Unix mechanisms in
2698use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2699and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2700which returns 0 for both end of file and no more data. We distinguish the
2701two cases by taking 0 as end of file only when we know the process has
2702completed.
2703
2704Each separate item is written to the pipe in a single write(), and as they are
2705all short items, the writes will all be atomic and we should never find
8e669ac1
PH
2706ourselves in the position of having read an incomplete item. "Short" in this
2707case can mean up to about 1K in the case when there is a long error message
1c5466b9 2708associated with an address. */
059ec3d9
PH
2709
2710DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2711 (int)p->pid, eop? "ended" : "not ended");
2712
2713while (!done)
2714 {
2715 retry_item *r, **rp;
2716 int remaining = endptr - ptr;
2717
2718 /* Read (first time) or top up the chars in the buffer if necessary.
2719 There will be only one read if we get all the available data (i.e. don't
2720 fill the buffer completely). */
2721
1c5466b9 2722 if (remaining < 2500 && unfinished)
059ec3d9
PH
2723 {
2724 int len;
2725 int available = big_buffer_size - remaining;
2726
2727 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2728
2729 ptr = big_buffer;
2730 endptr = big_buffer + remaining;
2731 len = read(fd, endptr, available);
2732
2733 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2734
2735 /* If the result is EAGAIN and the process is not complete, just
2736 stop reading any more and process what we have already. */
2737
2738 if (len < 0)
2739 {
2740 if (!eop && errno == EAGAIN) len = 0; else
2741 {
2742 msg = string_sprintf("failed to read pipe from transport process "
2743 "%d for transport %s: %s", pid, addr->transport->driver_name,
2744 strerror(errno));
2745 break;
2746 }
2747 }
2748
2749 /* If the length is zero (eof or no-more-data), just process what we
2750 already have. Note that if the process is still running and we have
2751 read all the data in the pipe (but less that "available") then we
2752 won't read any more, as "unfinished" will get set FALSE. */
2753
2754 endptr += len;
2755 unfinished = len == available;
2756 }
2757
2758 /* If we are at the end of the available data, exit the loop. */
2759
2760 if (ptr >= endptr) break;
2761
2762 /* Handle each possible type of item, assuming the complete item is
2763 available in store. */
2764
2765 switch (*ptr++)
2766 {
2767 /* Host items exist only if any hosts were marked unusable. Match
2768 up by checking the IP address. */
2769
2770 case 'H':
2771 for (h = addrlist->host_list; h != NULL; h = h->next)
2772 {
2773 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2774 h->status = ptr[0];
2775 h->why = ptr[1];
2776 }
2777 ptr += 2;
2778 while (*ptr++);
2779 break;
2780
2781 /* Retry items are sent in a preceding R item for each address. This is
2782 kept separate to keep each message short enough to guarantee it won't
2783 be split in the pipe. Hopefully, in the majority of cases, there won't in
2784 fact be any retry items at all.
2785
2786 The complete set of retry items might include an item to delete a
2787 routing retry if there was a previous routing delay. However, routing
2788 retries are also used when a remote transport identifies an address error.
2789 In that case, there may also be an "add" item for the same key. Arrange
2790 that a "delete" item is dropped in favour of an "add" item. */
2791
2792 case 'R':
2793 if (addr == NULL) goto ADDR_MISMATCH;
2794
2795 DEBUG(D_deliver|D_retry)
2796 debug_printf("reading retry information for %s from subprocess\n",
2797 ptr+1);
2798
2799 /* Cut out any "delete" items on the list. */
2800
2801 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2802 {
2803 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2804 {
2805 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2806 *rp = r->next; /* Excise a delete item */
2807 DEBUG(D_deliver|D_retry)
2808 debug_printf(" existing delete item dropped\n");
2809 }
2810 }
2811
2812 /* We want to add a delete item only if there is no non-delete item;
2813 however we still have to step ptr through the data. */
2814
2815 if (r == NULL || (*ptr & rf_delete) == 0)
2816 {
2817 r = store_get(sizeof(retry_item));
2818 r->next = addr->retries;
2819 addr->retries = r;
2820 r->flags = *ptr++;
2821 r->key = string_copy(ptr);
2822 while (*ptr++);
2823 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2824 ptr += sizeof(r->basic_errno);
2825 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2826 ptr += sizeof(r->more_errno);
2827 r->message = (*ptr)? string_copy(ptr) : NULL;
2828 DEBUG(D_deliver|D_retry)
2829 debug_printf(" added %s item\n",
2830 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2831 }
2832
2833 else
2834 {
2835 DEBUG(D_deliver|D_retry)
2836 debug_printf(" delete item not added: non-delete item exists\n");
2837 ptr++;
2838 while(*ptr++);
2839 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2840 }
2841
2842 while(*ptr++);
2843 break;
2844
2845 /* Put the amount of data written into the parlist block */
2846
2847 case 'S':
2848 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2849 ptr += sizeof(transport_count);
2850 break;
2851
2852 /* Address items are in the order of items on the address chain. We
2853 remember the current address value in case this function is called
2854 several times to empty the pipe in stages. Information about delivery
2855 over TLS is sent in a preceding X item for each address. We don't put
2856 it in with the other info, in order to keep each message short enough to
2857 guarantee it won't be split in the pipe. */
2858
2859 #ifdef SUPPORT_TLS
2860 case 'X':
2861 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2862 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2863 while (*ptr++);
2864 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2865 while (*ptr++);
2866 break;
2867 #endif
2868
2869 case 'A':
2870 if (addr == NULL)
2871 {
2872 ADDR_MISMATCH:
2873 msg = string_sprintf("address count mismatch for data read from pipe "
2874 "for transport process %d for transport %s", pid,
2875 addrlist->transport->driver_name);
2876 done = TRUE;
2877 break;
2878 }
2879
2880 addr->transport_return = *ptr++;
2881 addr->special_action = *ptr++;
2882 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2883 ptr += sizeof(addr->basic_errno);
2884 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2885 ptr += sizeof(addr->more_errno);
2886 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2887 ptr += sizeof(addr->flags);
2888 addr->message = (*ptr)? string_copy(ptr) : NULL;
2889 while(*ptr++);
2890 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2891 while(*ptr++);
2892
2893 /* Always two strings for host information, followed by the port number */
2894
2895 if (*ptr != 0)
2896 {
2897 h = store_get(sizeof(host_item));
2898 h->name = string_copy(ptr);
2899 while (*ptr++);
2900 h->address = string_copy(ptr);
2901 while(*ptr++);
2902 memcpy(&(h->port), ptr, sizeof(h->port));
2903 ptr += sizeof(h->port);
2904 addr->host_used = h;
2905 }
2906 else ptr++;
2907
2908 /* Finished with this address */
2909
2910 addr = addr->next;
2911 break;
2912
2913 /* Z marks the logical end of the data. It is followed by '0' if
2914 continue_transport was NULL at the end of transporting, otherwise '1'.
2915 We need to know when it becomes NULL during a delivery down a passed SMTP
2916 channel so that we don't try to pass anything more down it. Of course, for
2917 most normal messages it will remain NULL all the time. */
2918
2919 case 'Z':
2920 if (*ptr == '0')
2921 {
2922 continue_transport = NULL;
2923 continue_hostname = NULL;
2924 }
2925 done = TRUE;
2926 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
2927 break;
2928
2929 /* Anything else is a disaster. */
2930
2931 default:
2932 msg = string_sprintf("malformed data (%d) read from pipe for transport "
2933 "process %d for transport %s", ptr[-1], pid,
2934 addr->transport->driver_name);
2935 done = TRUE;
2936 break;
2937 }
2938 }
2939
2940/* The done flag is inspected externally, to determine whether or not to
2941call the function again when the process finishes. */
2942
2943p->done = done;
2944
2945/* If the process hadn't finished, and we haven't seen the end of the data
2946or suffered a disaster, update the rest of the state, and return FALSE to
2947indicate "not finished". */
2948
2949if (!eop && !done)
2950 {
2951 p->addr = addr;
2952 p->msg = msg;
2953 return FALSE;
2954 }
2955
2956/* Close our end of the pipe, to prevent deadlock if the far end is still
2957pushing stuff into it. */
2958
f1e894f3 2959(void)close(fd);
059ec3d9
PH
2960p->fd = -1;
2961
2962/* If we have finished without error, but haven't had data for every address,
2963something is wrong. */
2964
2965if (msg == NULL && addr != NULL)
2966 msg = string_sprintf("insufficient address data read from pipe "
2967 "for transport process %d for transport %s", pid,
2968 addr->transport->driver_name);
2969
2970/* If an error message is set, something has gone wrong in getting back
2971the delivery data. Put the message into each address and freeze it. */
2972
2973if (msg != NULL)
2974 {
2975 for (addr = addrlist; addr != NULL; addr = addr->next)
2976 {
2977 addr->transport_return = DEFER;
2978 addr->special_action = SPECIAL_FREEZE;
2979 addr->message = msg;
2980 }
2981 }
2982
2983/* Return TRUE to indicate we have got all we need from this process, even
2984if it hasn't actually finished yet. */
2985
2986return TRUE;
2987}
2988
2989
2990
2991/*************************************************
2992* Post-process a set of remote addresses *
2993*************************************************/
2994
2995/* Do what has to be done immediately after a remote delivery for each set of
2996addresses, then re-write the spool if necessary. Note that post_process_one
2997puts the address on an appropriate queue; hence we must fish off the next
2998one first. This function is also called if there is a problem with setting
2999up a subprocess to do a remote delivery in parallel. In this case, the final
3000argument contains a message, and the action must be forced to DEFER.
3001
3002Argument:
3003 addr pointer to chain of address items
3004 logflags flags for logging
3005 msg NULL for normal cases; -> error message for unexpected problems
3006 fallback TRUE if processing fallback hosts
3007
3008Returns: nothing
3009*/
3010
3011static void
3012remote_post_process(address_item *addr, int logflags, uschar *msg,
3013 BOOL fallback)
3014{
3015host_item *h;
3016
3017/* If any host addresses were found to be unusable, add them to the unusable
3018tree so that subsequent deliveries don't try them. */
3019
3020for (h = addr->host_list; h != NULL; h = h->next)
3021 {
3022 if (h->address == NULL) continue;
3023 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3024 }
3025
3026/* Now handle each address on the chain. The transport has placed '=' or '-'
3027into the special_action field for each successful delivery. */
3028
3029while (addr != NULL)
3030 {
3031 address_item *next = addr->next;
3032
3033 /* If msg == NULL (normal processing) and the result is DEFER and we are
3034 processing the main hosts and there are fallback hosts available, put the
3035 address on the list for fallback delivery. */
3036
3037 if (addr->transport_return == DEFER &&
3038 addr->fallback_hosts != NULL &&
3039 !fallback &&
3040 msg == NULL)
3041 {
3042 addr->host_list = addr->fallback_hosts;
3043 addr->next = addr_fallback;
3044 addr_fallback = addr;
3045 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3046 }
3047
3048 /* If msg is set (=> unexpected problem), set it in the address before
3049 doing the ordinary post processing. */
3050
3051 else
3052 {
3053 if (msg != NULL)
3054 {
3055 addr->message = msg;
3056 addr->transport_return = DEFER;
3057 }
3058 (void)post_process_one(addr, addr->transport_return, logflags,
3059 DTYPE_TRANSPORT, addr->special_action);
3060 }
3061
3062 /* Next address */
3063
3064 addr = next;
3065 }
3066
3067/* If we have just delivered down a passed SMTP channel, and that was
3068the last address, the channel will have been closed down. Now that
3069we have logged that delivery, set continue_sequence to 1 so that
3070any subsequent deliveries don't get "*" incorrectly logged. */
3071
3072if (continue_transport == NULL) continue_sequence = 1;
3073}
3074
3075
3076
3077/*************************************************
3078* Wait for one remote delivery subprocess *
3079*************************************************/
3080
3081/* This function is called while doing remote deliveries when either the
3082maximum number of processes exist and we need one to complete so that another
3083can be created, or when waiting for the last ones to complete. It must wait for
3084the completion of one subprocess, empty the control block slot, and return a
3085pointer to the address chain.
3086
3087Arguments: none
3088Returns: pointer to the chain of addresses handled by the process;
3089 NULL if no subprocess found - this is an unexpected error
3090*/
3091
3092static address_item *
3093par_wait(void)
3094{
3095int poffset, status;
3096address_item *addr, *addrlist;
3097pid_t pid;
3098
3099set_process_info("delivering %s: waiting for a remote delivery subprocess "
3100 "to finish", message_id);
3101
3102/* Loop until either a subprocess completes, or there are no subprocesses in
3103existence - in which case give an error return. We cannot proceed just by
3104waiting for a completion, because a subprocess may have filled up its pipe, and
3105be waiting for it to be emptied. Therefore, if no processes have finished, we
3106wait for one of the pipes to acquire some data by calling select(), with a
3107timeout just in case.
3108
3109The simple approach is just to iterate after reading data from a ready pipe.
3110This leads to non-ideal behaviour when the subprocess has written its final Z
3111item, closed the pipe, and is in the process of exiting (the common case). A
3112call to waitpid() yields nothing completed, but select() shows the pipe ready -
3113reading it yields EOF, so you end up with busy-waiting until the subprocess has
3114actually finished.
3115
3116To avoid this, if all the data that is needed has been read from a subprocess
3117after select(), an explicit wait() for it is done. We know that all it is doing
3118is writing to the pipe and then exiting, so the wait should not be long.
3119
3120The non-blocking waitpid() is to some extent just insurance; if we could
3121reliably detect end-of-file on the pipe, we could always know when to do a
3122blocking wait() for a completed process. However, because some systems use
3123NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3124use code that functions without the need to recognize EOF.
3125
3126There's a double loop here just in case we end up with a process that is not in
3127the list of remote delivery processes. Something has obviously gone wrong if
3128this is the case. (For example, a process that is incorrectly left over from
3129routing or local deliveries might be found.) The damage can be minimized by
3130looping back and looking for another process. If there aren't any, the error
3131return will happen. */
3132
3133for (;;) /* Normally we do not repeat this loop */
3134 {
3135 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3136 {
3137 struct timeval tv;
3138 fd_set select_pipes;
3139 int maxpipe, readycount;
3140
3141 /* A return value of -1 can mean several things. If errno != ECHILD, it
3142 either means invalid options (which we discount), or that this process was
3143 interrupted by a signal. Just loop to try the waitpid() again.
3144
3145 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3146 in existence. This should never happen, and is an unexpected error.
3147 However, there is a nasty complication when running under Linux. If "strace
3148 -f" is being used under Linux to trace this process and its children,
3149 subprocesses are "stolen" from their parents and become the children of the
3150 tracing process. A general wait such as the one we've just obeyed returns
3151 as if there are no children while subprocesses are running. Once a
3152 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3153 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3154 palliative.
3155
3156 This does not happen using "truss" on Solaris, nor (I think) with other
3157 tracing facilities on other OS. It seems to be specific to Linux.
3158
3159 What we do to get round this is to use kill() to see if any of our
3160 subprocesses are still in existence. If kill() gives an OK return, we know
3161 it must be for one of our processes - it can't be for a re-use of the pid,
3162 because if our process had finished, waitpid() would have found it. If any
3163 of our subprocesses are in existence, we proceed to use select() as if
3164 waitpid() had returned zero. I think this is safe. */
3165
3166 if (pid < 0)
3167 {
3168 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3169
3170 DEBUG(D_deliver)
3171 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3172 "for process existence\n");
3173
3174 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3175 {
3176 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3177 {
3178 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3179 "stolen by strace\n", (int)pid);
3180 break; /* With poffset set */
3181 }
3182 }
3183
3184 if (poffset >= remote_max_parallel)
3185 {
3186 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3187 return NULL; /* This is the error return */
3188 }
3189 }
3190
3191 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3192 been handled above. A return value of zero means that there is at least one
3193 subprocess, but there are no completed subprocesses. See if any pipes are
3194 ready with any data for reading. */
3195
3196 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3197
3198 maxpipe = 0;
3199 FD_ZERO(&select_pipes);
3200 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3201 {
3202 if (parlist[poffset].pid != 0)
3203 {
3204 int fd = parlist[poffset].fd;
3205 FD_SET(fd, &select_pipes);
3206 if (fd > maxpipe) maxpipe = fd;
3207 }
3208 }
3209
3210 /* Stick in a 60-second timeout, just in case. */
3211
3212 tv.tv_sec = 60;
3213 tv.tv_usec = 0;
3214
3215 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3216 NULL, NULL, &tv);
3217
3218 /* Scan through the pipes and read any that are ready; use the count
3219 returned by select() to stop when there are no more. Select() can return
3220 with no processes (e.g. if interrupted). This shouldn't matter.
3221
3222 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3223 read, or there was a disaster. In either case, we are finished with this
3224 process. Do an explicit wait() for the process and break the main loop if
3225 it succeeds.
3226
3227 It turns out that we have to deal with the case of an interrupted system
3228 call, which can happen on some operating systems if the signal handling is
3229 set up to do that by default. */
3230
3231 for (poffset = 0;
3232 readycount > 0 && poffset < remote_max_parallel;
3233 poffset++)
3234 {
3235 if ((pid = parlist[poffset].pid) != 0 &&
3236 FD_ISSET(parlist[poffset].fd, &select_pipes))
3237 {
3238 readycount--;
3239 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3240 {
3241 for (;;) /* Loop for signals */
3242 {
3243 pid_t endedpid = waitpid(pid, &status, 0);
3244 if (endedpid == pid) goto PROCESS_DONE;
3245 if (endedpid != (pid_t)(-1) || errno != EINTR)
3246 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3247 "%d (errno = %d) from waitpid() for process %d",
3248 (int)endedpid, errno, (int)pid);
3249 }
3250 }
3251 }
3252 }
3253
3254 /* Now go back and look for a completed subprocess again. */
3255 }
3256
3257 /* A completed process was detected by the non-blocking waitpid(). Find the
3258 data block that corresponds to this subprocess. */
3259
3260 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3261 if (pid == parlist[poffset].pid) break;
3262
3263 /* Found the data block; this is a known remote delivery process. We don't
3264 need to repeat the outer loop. This should be what normally happens. */
3265
3266 if (poffset < remote_max_parallel) break;
3267
3268 /* This situation is an error, but it's probably better to carry on looking
3269 for another process than to give up (as we used to do). */
3270
3271 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3272 "transport process list", pid);
3273 } /* End of the "for" loop */
3274
3275/* Come here when all the data was completely read after a select(), and
3276the process in pid has been wait()ed for. */
3277
3278PROCESS_DONE:
3279
3280DEBUG(D_deliver)
3281 {
3282 if (status == 0)
3283 debug_printf("remote delivery process %d ended\n", (int)pid);
3284 else
3285 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3286 status);
3287 }
3288
3289set_process_info("delivering %s", message_id);
3290
3291/* Get the chain of processed addresses */
3292
3293addrlist = parlist[poffset].addrlist;
3294
3295/* If the process did not finish cleanly, record an error and freeze (except
3296for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3297in case the delivery did actually happen. */
3298
3299if ((status & 0xffff) != 0)
3300 {
3301 uschar *msg;
3302 int msb = (status >> 8) & 255;
3303 int lsb = status & 255;
3304 int code = (msb == 0)? (lsb & 0x7f) : msb;
3305
3306 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3307 "%s %d",
3308 addrlist->transport->driver_name,
3309 status,
3310 (msb == 0)? "terminated by signal" : "exit code",
3311 code);
3312
3313 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3314 addrlist->special_action = SPECIAL_FREEZE;
3315
3316 for (addr = addrlist; addr != NULL; addr = addr->next)
3317 {
3318 addr->transport_return = DEFER;
3319 addr->message = msg;
3320 }
3321
3322 remove_journal = FALSE;
3323 }
3324
3325/* Else complete reading the pipe to get the result of the delivery, if all
3326the data has not yet been obtained. */
3327
3328else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3329
3330/* Put the data count and return path into globals, mark the data slot unused,
3331decrement the count of subprocesses, and return the address chain. */
3332
3333transport_count = parlist[poffset].transport_count;
3334used_return_path = parlist[poffset].return_path;
3335parlist[poffset].pid = 0;
3336parcount--;
3337return addrlist;
3338}
3339
3340
3341
3342/*************************************************
3343* Wait for subprocesses and post-process *
3344*************************************************/
3345
3346/* This function waits for subprocesses until the number that are still running
3347is below a given threshold. For each complete subprocess, the addresses are
3348post-processed. If we can't find a running process, there is some shambles.
3349Better not bomb out, as that might lead to multiple copies of the message. Just
3350log and proceed as if all done.
3351
3352Arguments:
3353 max maximum number of subprocesses to leave running
3354 fallback TRUE if processing fallback hosts
3355
3356Returns: nothing
3357*/
3358
3359static void
3360par_reduce(int max, BOOL fallback)
3361{
3362while (parcount > max)
3363 {
3364 address_item *doneaddr = par_wait();
3365 if (doneaddr == NULL)
3366 {
3367 log_write(0, LOG_MAIN|LOG_PANIC,
3368 "remote delivery process count got out of step");
3369 parcount = 0;
3370 }
3371 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3372 }
3373}
3374
3375
3376
3377
3378/*************************************************
3379* Do remote deliveries *
3380*************************************************/
3381
3382/* This function is called to process the addresses in addr_remote. We must
3383pick off the queue all addresses that have the same transport, remote
3384destination, and errors address, and hand them to the transport in one go,
3385subject to some configured limitations. If this is a run to continue delivering
3386to an existing delivery channel, skip all but those addresses that can go to
3387that channel. The skipped addresses just get deferred.
3388
3389If mua_wrapper is set, all addresses must be able to be sent in a single
3390transaction. If not, this function yields FALSE.
3391
3392In Exim 4, remote deliveries are always done in separate processes, even
3393if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3394is so that the base process can retain privilege. This makes the
3395implementation of fallback transports feasible (though not initially done.)
3396
3397We create up to the configured number of subprocesses, each of which passes
3398back the delivery state via a pipe. (However, when sending down an existing
3399connection, remote_max_parallel is forced to 1.)
3400
3401Arguments:
3402 fallback TRUE if processing fallback hosts
3403
3404Returns: TRUE normally
3405 FALSE if mua_wrapper is set and the addresses cannot all be sent
3406 in one transaction
3407*/
3408
3409static BOOL
3410do_remote_deliveries(BOOL fallback)
3411{
3412int parmax;
3413int delivery_count;
3414int poffset;
3415
3416parcount = 0; /* Number of executing subprocesses */
3417
3418/* When sending down an existing channel, only do one delivery at a time.
3419We use a local variable (parmax) to hold the maximum number of processes;
3420this gets reduced from remote_max_parallel if we can't create enough pipes. */
3421
3422if (continue_transport != NULL) remote_max_parallel = 1;
3423parmax = remote_max_parallel;
3424
3425/* If the data for keeping a list of processes hasn't yet been
3426set up, do so. */
3427
3428if (parlist == NULL)
3429 {
3430 parlist = store_get(remote_max_parallel * sizeof(pardata));
3431 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3432 parlist[poffset].pid = 0;
3433 }
3434
3435/* Now loop for each remote delivery */
3436
3437for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3438 {
3439 pid_t pid;
3440 uid_t uid;
3441 gid_t gid;
3442 int pfd[2];
3443 int address_count = 1;
3444 int address_count_max;
3445 BOOL multi_domain;
3446 BOOL use_initgroups;
3447 BOOL pipe_done = FALSE;
3448 transport_instance *tp;
3449 address_item **anchor = &addr_remote;
3450 address_item *addr = addr_remote;
3451 address_item *last = addr;
3452 address_item *next;
3453
3454 /* Pull the first address right off the list. */
3455
3456 addr_remote = addr->next;
3457 addr->next = NULL;
3458
3459 DEBUG(D_deliver|D_transport)
3460 debug_printf("--------> %s <--------\n", addr->address);
3461
3462 /* If no transport has been set, there has been a big screw-up somewhere. */
3463
3464 if ((tp = addr->transport) == NULL)
3465 {
3466 disable_logging = FALSE; /* Jic */
3467 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3468 US"No transport set by router", fallback);
3469 continue;
3470 }
3471
3472 /* Check that this base address hasn't previously been delivered to this
3473 transport. The check is necessary at this point to handle homonymic addresses
3474 correctly in cases where the pattern of redirection changes between delivery
3475 attempts. Non-homonymic previous delivery is detected earlier, at routing
3476 time. */
3477
c2c19e9d 3478 if (previously_transported(addr, FALSE)) continue;
059ec3d9
PH
3479
3480 /* Force failure if the message is too big. */
3481
3482 if (tp->message_size_limit != NULL)
3483 {
3484 int rc = check_message_size(tp, addr);
3485 if (rc != OK)
3486 {
3487 addr->transport_return = rc;
3488 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3489 continue;
3490 }
3491 }
3492
3493 /* Get the flag which specifies whether the transport can handle different
3494 domains that nevertheless resolve to the same set of hosts. */
3495
3496 multi_domain = tp->multi_domain;
3497
3498 /* Get the maximum it can handle in one envelope, with zero meaning
3499 unlimited, which is forced for the MUA wrapper case. */
3500
3501 address_count_max = tp->max_addresses;
3502 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3503
3504
3505 /************************************************************************/
3506 /***** This is slightly experimental code, but should be safe. *****/
3507
3508 /* The address_count_max value is the maximum number of addresses that the
3509 transport can send in one envelope. However, the transport must be capable of
3510 dealing with any number of addresses. If the number it gets exceeds its
3511 envelope limitation, it must send multiple copies of the message. This can be
3512 done over a single connection for SMTP, so uses less resources than making
3513 multiple connections. On the other hand, if remote_max_parallel is greater
3514 than one, it is perhaps a good idea to use parallel processing to move the
3515 message faster, even if that results in multiple simultaneous connections to
3516 the same host.
3517
3518 How can we come to some compromise between these two ideals? What we do is to
3519 limit the number of addresses passed to a single instance of a transport to
3520 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3521 number of addresses routed to remote transports divided by
3522 remote_max_parallel. For example, if the message has 100 remote recipients,
3523 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3524 once. But if rcpt_max is 100, we could send up to 100.
3525
3526 Of course, not all the remotely addresses in a message are going to go to the
3527 same set of hosts (except in smarthost configurations), so this is just a
3528 heuristic way of dividing up the work.
3529
3530 Furthermore (1), because this may not be wanted in some cases, and also to
3531 cope with really pathological cases, there is also a limit to the number of
3532 messages that are sent over one connection. This is the same limit that is
3533 used when sending several different messages over the same connection.
3534 Continue_sequence is set when in this situation, to the number sent so
3535 far, including this message.
3536
3537 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3538 is probably because they are using VERP, in which case they want to pass only
3539 one address at a time to the transport, in order to be able to use
3540 $local_part and $domain in constructing a new return path. We could test for
3541 the use of these variables, but as it is so likely they will be used when the
3542 maximum is 1, we don't bother. Just leave the value alone. */
3543
3544 if (address_count_max != 1 &&
3545 address_count_max < remote_delivery_count/remote_max_parallel)
3546 {
3547 int new_max = remote_delivery_count/remote_max_parallel;
3548 int message_max = tp->connection_max_messages;
3549 if (connection_max_messages >= 0) message_max = connection_max_messages;
3550 message_max -= continue_sequence - 1;
3551 if (message_max > 0 && new_max > address_count_max * message_max)
3552 new_max = address_count_max * message_max;
3553 address_count_max = new_max;
3554 }
3555
3556 /************************************************************************/
3557
3558
3559 /* Pick off all addresses which have the same transport, errors address,
3560 destination, and extra headers. In some cases they point to the same host
3561 list, but we also need to check for identical host lists generated from
3562 entirely different domains. The host list pointers can be NULL in the case
3563 where the hosts are defined in the transport. There is also a configured
3564 maximum limit of addresses that can be handled at once (see comments above
3565 for how it is computed). */
3566
3567 while ((next = *anchor) != NULL && address_count < address_count_max)
3568 {
3569 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3570 &&
3571 tp == next->transport
3572 &&
3573 same_hosts(next->host_list, addr->host_list)
3574 &&
3575 same_strings(next->p.errors_address, addr->p.errors_address)
3576 &&
3577 same_headers(next->p.extra_headers, addr->p.extra_headers)
3578 &&
3579 same_ugid(tp, next, addr)
3580 &&
3581 (next->p.remove_headers == addr->p.remove_headers ||
3582 (next->p.remove_headers != NULL &&
3583 addr->p.remove_headers != NULL &&
3584 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3585 {
3586 *anchor = next->next;
3587 next->next = NULL;
3588 next->first = addr; /* remember top one (for retry processing) */
3589 last->next = next;
3590 last = next;
3591 address_count++;
3592 }
3593 else anchor = &(next->next);
3594 }
3595
3596 /* If we are acting as an MUA wrapper, all addresses must go in a single
3597 transaction. If not, put them back on the chain and yield FALSE. */
3598
3599 if (mua_wrapper && addr_remote != NULL)
3600 {
3601 last->next = addr_remote;
3602 addr_remote = addr;
3603 return FALSE;
3604 }
3605
3606 /* Set up the expansion variables for this set of addresses */
3607
3608 deliver_set_expansions(addr);
3609
3610 /* Compute the return path, expanding a new one if required. The old one
3611 must be set first, as it might be referred to in the expansion. */
3612
384152a6
TK
3613 if(addr->p.errors_address != NULL)
3614 return_path = addr->p.errors_address;
3615#ifdef EXPERIMENTAL_SRS
3616 else if(addr->p.srs_sender != NULL)
3617 return_path = addr->p.srs_sender;
3618#endif
3619 else
3620 return_path = sender_address;
059ec3d9
PH
3621
3622 if (tp->return_path != NULL)
3623 {
3624 uschar *new_return_path = expand_string(tp->return_path);
3625 if (new_return_path == NULL)
3626 {
3627 if (!expand_string_forcedfail)
3628 {
3629 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3630 string_sprintf("Failed to expand return path \"%s\": %s",
3631 tp->return_path, expand_string_message), fallback);
3632 continue;
3633 }
3634 }
3635 else return_path = new_return_path;
3636 }
3637
929ba01c
PH
3638 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3639 logs and sets up error messages, so we just post-process and continue with
3640 the next address. */
3641
3642 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3643 {
3644 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3645 continue;
3646 }
3647
059ec3d9
PH
3648 /* If this transport has a setup function, call it now so that it gets
3649 run in this process and not in any subprocess. That way, the results of
929ba01c
PH
3650 any setup that are retained by the transport can be reusable. One of the
3651 things the setup does is to set the fallback host lists in the addresses.
3652 That is why it is called at this point, before the continue delivery
3653 processing, because that might use the fallback hosts. */
059ec3d9
PH
3654
3655 if (tp->setup != NULL)
929ba01c 3656 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
059ec3d9
PH
3657
3658 /* If this is a run to continue delivery down an already-established
3659 channel, check that this set of addresses matches the transport and
3660 the channel. If it does not, defer the addresses. If a host list exists,
3661 we must check that the continue host is on the list. Otherwise, the
3662 host is set in the transport. */
3663
3664 continue_more = FALSE; /* In case got set for the last lot */
3665 if (continue_transport != NULL)
3666 {
3667 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3668 if (ok && addr->host_list != NULL)
3669 {
3670 host_item *h;
3671 ok = FALSE;
3672 for (h = addr->host_list; h != NULL; h = h->next)
3673 {
3674 if (Ustrcmp(h->name, continue_hostname) == 0)
3675 { ok = TRUE; break; }
3676 }
3677 }
3678
3679 /* Addresses not suitable; defer or queue for fallback hosts (which
3680 might be the continue host) and skip to next address. */
3681
3682 if (!ok)
3683 {
3684 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3685 next = addr;
3686
3687 if (addr->fallback_hosts != NULL && !fallback)
3688 {
3689 for (;;)
3690 {
3691 next->host_list = next->fallback_hosts;
3692 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3693 if (next->next == NULL) break;
3694 next = next->next;
3695 }
3696 next->next = addr_fallback;
3697 addr_fallback = addr;
3698 }
3699
3700 else
3701 {
3702 while (next->next != NULL) next = next->next;
3703 next->next = addr_defer;
3704 addr_defer = addr;
3705 }
3706
3707 continue;
3708 }
3709
3710 /* Set a flag indicating whether there are further addresses that list
3711 the continued host. This tells the transport to leave the channel open,
3712 but not to pass it to another delivery process. */
3713
3714 for (next = addr_remote; next != NULL; next = next->next)
3715 {
3716 host_item *h;
3717 for (h = next->host_list; h != NULL; h = h->next)
3718 {
3719 if (Ustrcmp(h->name, continue_hostname) == 0)
3720 { continue_more = TRUE; break; }
3721 }
3722 }
3723 }
3724
3725 /* The transports set up the process info themselves as they may connect
3726 to more than one remote machine. They also have to set up the filter
3727 arguments, if required, so that the host name and address are available
3728 for expansion. */
3729
3730 transport_filter_argv = NULL;
3731
059ec3d9
PH
3732 /* Create the pipe for inter-process communication. If pipe creation
3733 fails, it is probably because the value of remote_max_parallel is so
3734 large that too many file descriptors for pipes have been created. Arrange
3735 to wait for a process to finish, and then try again. If we still can't
3736 create a pipe when all processes have finished, break the retry loop. */
3737
3738 while (!pipe_done)
3739 {
3740 if (pipe(pfd) == 0) pipe_done = TRUE;
3741 else if (parcount > 0) parmax = parcount;
3742 else break;
3743
3744 /* We need to make the reading end of the pipe non-blocking. There are
3745 two different options for this. Exim is cunningly (I hope!) coded so
3746 that it can use either of them, though it prefers O_NONBLOCK, which
3747 distinguishes between EOF and no-more-data. */
3748
3749 #ifdef O_NONBLOCK
ff790e47 3750 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
059ec3d9 3751 #else
ff790e47 3752 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
059ec3d9
PH
3753 #endif
3754
3755 /* If the maximum number of subprocesses already exist, wait for a process
3756 to finish. If we ran out of file descriptors, parmax will have been reduced
3757 from its initial value of remote_max_parallel. */
3758
3759 par_reduce(parmax - 1, fallback);
3760 }
3761
3762 /* If we failed to create a pipe and there were no processes to wait
3763 for, we have to give up on this one. Do this outside the above loop
3764 so that we can continue the main loop. */
3765
3766 if (!pipe_done)
3767 {
3768 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3769 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3770 continue;
3771 }
3772
3773 /* Find a free slot in the pardata list. Must do this after the possible
3774 waiting for processes to finish, because a terminating process will free
3775 up a slot. */
3776
3777 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3778 if (parlist[poffset].pid == 0) break;
3779
3780 /* If there isn't one, there has been a horrible disaster. */
3781
3782 if (poffset >= remote_max_parallel)
3783 {
f1e894f3
PH
3784 (void)close(pfd[pipe_write]);
3785 (void)close(pfd[pipe_read]);
059ec3d9
PH
3786 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3787 US"Unexpectedly no free subprocess slot", fallback);
3788 continue;
3789 }
3790
3791 /* Now fork a subprocess to do the remote delivery, but before doing so,
3792 ensure that any cached resourses are released so as not to interfere with
3793 what happens in the subprocess. */
3794
3795 search_tidyup();
3796
3797 if ((pid = fork()) == 0)
3798 {
3799 int fd = pfd[pipe_write];
3800 host_item *h;
3801
3802 /* There are weird circumstances in which logging is disabled */
3803
3804 disable_logging = tp->disable_logging;
3805
3806 /* Show pids on debug output if parallelism possible */
3807
3808 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3809 {
3810 DEBUG(D_any|D_v) debug_selector |= D_pid;
3811 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3812 }
3813
3814 /* Reset the random number generator, so different processes don't all
3815 have the same sequence. In the test harness we want different, but
3816 predictable settings for each delivery process, so do something explicit
3817 here rather they rely on the fixed reset in the random number function. */
3818
3819 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3820
3821 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3822 a new process that may be forked to do another delivery down the same
3823 SMTP connection. */
3824
ff790e47 3825 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
059ec3d9
PH
3826
3827 /* Close open file descriptors for the pipes of other processes
3828 that are running in parallel. */
3829
3830 for (poffset = 0; poffset < remote_max_parallel; poffset++)
f1e894f3 3831 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
059ec3d9
PH
3832
3833 /* This process has inherited a copy of the file descriptor
3834 for the data file, but its file pointer is shared with all the
3835 other processes running in parallel. Therefore, we have to re-open
3836 the file in order to get a new file descriptor with its own
3837 file pointer. We don't need to lock it, as the lock is held by
3838 the parent process. There doesn't seem to be any way of doing
3839 a dup-with-new-file-pointer. */
3840
f1e894f3 3841 (void)close(deliver_datafile);
059ec3d9
PH
3842 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3843 message_id);
3844 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3845
3846 if (deliver_datafile < 0)
3847 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3848 "parallel delivery: %s", spoolname, strerror(errno));
3849
3850 /* Set the close-on-exec flag */
3851
ff790e47 3852 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
059ec3d9
PH
3853 FD_CLOEXEC);
3854
3855 /* Set the uid/gid of this process; bombs out on failure. */
3856
3857 exim_setugid(uid, gid, use_initgroups,
3858 string_sprintf("remote delivery to %s with transport=%s",
3859 addr->address, tp->name));
3860
3861 /* Close the unwanted half of this process' pipe, set the process state,
3862 and run the transport. Afterwards, transport_count will contain the number
3863 of bytes written. */
3864
f1e894f3 3865 (void)close(pfd[pipe_read]);
059ec3d9
PH
3866 set_process_info("delivering %s using %s", message_id, tp->name);
3867 debug_print_string(tp->debug_string);
3868 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3869
3870 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3871 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3872
3873 /* Ensure any cached resources that we used are now released */
3874
3875 search_tidyup();
3876
3877 /* Pass the result back down the pipe. This is a lot more information
3878 than is needed for a local delivery. We have to send back the error
3879 status for each address, the usability status for each host that is
3880 flagged as unusable, and all the retry items. When TLS is in use, we
3881 send also the cipher and peerdn information. Each type of information
3882 is flagged by an identifying byte, and is then in a fixed format (with
3883 strings terminated by zeros), and there is a final terminator at the
3884 end. The host information and retry information is all attached to
3885 the first address, so that gets sent at the start. */
3886
3887 /* Host unusability information: for most success cases this will
3888 be null. */
3889
3890 for (h = addr->host_list; h != NULL; h = h->next)
3891 {
3892 if (h->address == NULL || h->status < hstatus_unusable) continue;
3893 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
f1e894f3 3894 (void)write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
059ec3d9
PH
3895 }
3896
3897 /* The number of bytes written. This is the same for each address. Even
3898 if we sent several copies of the message down the same connection, the
3899 size of each one is the same, and it's that value we have got because
3900 transport_count gets reset before calling transport_write_message(). */
3901
3902 big_buffer[0] = 'S';
3903 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
f1e894f3 3904 (void)write(fd, big_buffer, sizeof(transport_count) + 1);
059ec3d9
PH
3905
3906 /* Information about what happened to each address. Three item types are
3907 used: an optional 'X' item first, for TLS information, followed by 'R'
3908 items for any retry settings, and finally an 'A' item for the remaining
3909 data. */
3910
3911 for(; addr != NULL; addr = addr->next)
3912 {
3913 uschar *ptr;
3914 retry_item *r;
3915
3916 /* The certificate verification status goes into the flags */
3917
3918 if (tls_certificate_verified) setflag(addr, af_cert_verified);
3919
3920 /* Use an X item only if there's something to send */
3921
3922 #ifdef SUPPORT_TLS
3923 if (addr->cipher != NULL)
3924 {
3925 ptr = big_buffer;
3926 *ptr++ = 'X';
3927 sprintf(CS ptr, "%.128s", addr->cipher);
3928 while(*ptr++);
3929 if (addr->peerdn == NULL) *ptr++ = 0; else
3930 {
3931 sprintf(CS ptr, "%.512s", addr->peerdn);
3932 while(*ptr++);
3933 }
f1e894f3 3934 (void)write(fd, big_buffer, ptr - big_buffer);
059ec3d9
PH
3935 }
3936 #endif
3937
3938 /* Retry information: for most success cases this will be null. */
3939
3940 for (r = addr->retries; r != NULL; r = r->next)
3941 {
3942 uschar *ptr;
3943 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
3944 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
3945 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
3946 ptr += sizeof(r->basic_errno);
3947 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
3948 ptr += sizeof(r->more_errno);
3949 if (r->message == NULL) *ptr++ = 0; else
3950 {
3951 sprintf(CS ptr, "%.512s", r->message);
3952 while(*ptr++);
3953 }
f1e894f3 3954 (void)write(fd, big_buffer, ptr - big_buffer);
059ec3d9
PH
3955 }
3956
3957 /* The rest of the information goes in an 'A' item. */
3958
3959 ptr = big_buffer + 3;
3960 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
3961 addr->special_action);
3962 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
3963 ptr += sizeof(addr->basic_errno);
3964 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
3965 ptr += sizeof(addr->more_errno);
3966 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
3967 ptr += sizeof(addr->flags);
3968
3969 if (addr->message == NULL) *ptr++ = 0; else
3970 {
3971 sprintf(CS ptr, "%.1024s", addr->message);
3972 while(*ptr++);
3973 }
3974
3975 if (addr->user_message == NULL) *ptr++ = 0; else
3976 {
3977 sprintf(CS ptr, "%.1024s", addr->user_message);
3978 while(*ptr++);
3979 }
3980
3981 if (addr->host_used == NULL) *ptr++ = 0; else
3982 {
3983 sprintf(CS ptr, "%.256s", addr->host_used->name);
3984 while(*ptr++);
3985 sprintf(CS ptr, "%.64s", addr->host_used->address);
3986 while(*ptr++);
3987 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
3988 ptr += sizeof(addr->host_used->port);
3989 }
f1e894f3 3990 (void)write(fd, big_buffer, ptr - big_buffer);
059ec3d9
PH
3991 }
3992
3993 /* Add termination flag, close the pipe, and that's it. The character
3994 after 'Z' indicates whether continue_transport is now NULL or not.
3995 A change from non-NULL to NULL indicates a problem with a continuing
3996 connection. */
3997
3998 big_buffer[0] = 'Z';
3999 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
f1e894f3
PH
4000 (void)write(fd, big_buffer, 2);
4001 (void)close(fd);
059ec3d9
PH
4002 exit(EXIT_SUCCESS);
4003 }
4004
4005 /* Back in the mainline: close the unwanted half of the pipe. */
4006
f1e894f3 4007 (void)close(pfd[pipe_write]);
059ec3d9
PH
4008
4009 /* Fork failed; defer with error message */
4010
4011 if (pid < 0)
4012 {
f1e894f3 4013 (void)close(pfd[pipe_read]);
059ec3d9
PH
4014 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4015 string_sprintf("fork failed for remote delivery to %s: %s",
4016 addr->domain, strerror(errno)), fallback);
4017 continue;
4018 }
4019
4020 /* Fork succeeded; increment the count, and remember relevant data for
4021 when the process finishes. */
4022
4023 parcount++;
4024 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4025 parlist[poffset].pid = pid;
4026 parlist[poffset].fd = pfd[pipe_read];
4027 parlist[poffset].done = FALSE;
4028 parlist[poffset].msg = NULL;
4029 parlist[poffset].return_path = return_path;
4030
4031 /* If the process we've just started is sending a message down an existing
4032 channel, wait for it now. This ensures that only one such process runs at
4033 once, whatever the value of remote_max parallel. Otherwise, we might try to
4034 send two or more messages simultaneously down the same channel. This could
4035 happen if there are different domains that include the same host in otherwise
4036 different host lists.
4037
4038 Also, if the transport closes down the channel, this information gets back
4039 (continue_transport gets set to NULL) before we consider any other addresses
4040 in this message. */
4041
4042 if (continue_transport != NULL) par_reduce(0, fallback);
4043
4044 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4045 newly created process get going before we create another process. This should
4046 ensure repeatability in the tests. We only need to wait a tad. */
4047
4048 else if (running_in_test_harness) millisleep(500);
4049 }
4050
4051/* Reached the end of the list of addresses. Wait for all the subprocesses that
4052are still running and post-process their addresses. */
4053
4054par_reduce(0, fallback);
4055return TRUE;
4056}