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