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