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