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