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