Docs: add caution on spamd_address
[exim.git] / src / src / transport.c
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
80fea873 5/* Copyright (c) University of Cambridge 1995 - 2016 */
059ec3d9
PH
6/* See the file NOTICE for conditions of use and distribution. */
7
8/* General functions concerned with transportation, and generic options for all
9transports. */
10
11
12#include "exim.h"
13
a8530a10
TK
14#ifdef HAVE_LINUX_SENDFILE
15#include <sys/sendfile.h>
16#endif
059ec3d9
PH
17
18/* Structure for keeping list of addresses that have been added to
19Envelope-To:, in order to avoid duplication. */
20
21struct aci {
22 struct aci *next;
23 address_item *ptr;
24 };
25
26
27/* Static data for write_chunk() */
28
29static uschar *chunk_ptr; /* chunk pointer */
30static uschar *nl_check; /* string to look for at line start */
31static int nl_check_length; /* length of same */
32static uschar *nl_escape; /* string to insert */
33static int nl_escape_length; /* length of same */
34static int nl_partial_match; /* length matched at chunk end */
35
36
37/* Generic options for transports, all of which live inside transport_instance
38data blocks and which therefore have the opt_public flag set. Note that there
39are other options living inside this structure which can be set only from
40certain transports. */
41
42optionlist optionlist_transports[] = {
43 { "*expand_group", opt_stringptr|opt_hidden|opt_public,
44 (void *)offsetof(transport_instance, expand_gid) },
45 { "*expand_user", opt_stringptr|opt_hidden|opt_public,
46 (void *)offsetof(transport_instance, expand_uid) },
47 { "*headers_rewrite_flags", opt_int|opt_public|opt_hidden,
48 (void *)offsetof(transport_instance, rewrite_existflags) },
49 { "*headers_rewrite_rules", opt_void|opt_public|opt_hidden,
50 (void *)offsetof(transport_instance, rewrite_rules) },
51 { "*set_group", opt_bool|opt_hidden|opt_public,
52 (void *)offsetof(transport_instance, gid_set) },
53 { "*set_user", opt_bool|opt_hidden|opt_public,
54 (void *)offsetof(transport_instance, uid_set) },
55 { "body_only", opt_bool|opt_public,
56 (void *)offsetof(transport_instance, body_only) },
57 { "current_directory", opt_stringptr|opt_public,
58 (void *)offsetof(transport_instance, current_dir) },
59 { "debug_print", opt_stringptr | opt_public,
60 (void *)offsetof(transport_instance, debug_string) },
61 { "delivery_date_add", opt_bool|opt_public,
62 (void *)(offsetof(transport_instance, delivery_date_add)) },
63 { "disable_logging", opt_bool|opt_public,
64 (void *)(offsetof(transport_instance, disable_logging)) },
65 { "driver", opt_stringptr|opt_public,
66 (void *)offsetof(transport_instance, driver_name) },
67 { "envelope_to_add", opt_bool|opt_public,
68 (void *)(offsetof(transport_instance, envelope_to_add)) },
0cbf2b82 69#ifndef DISABLE_EVENT
774ef2d7
JH
70 { "event_action", opt_stringptr | opt_public,
71 (void *)offsetof(transport_instance, event_action) },
72#endif
059ec3d9
PH
73 { "group", opt_expand_gid|opt_public,
74 (void *)offsetof(transport_instance, gid) },
846726c5 75 { "headers_add", opt_stringptr|opt_public|opt_rep_str,
059ec3d9
PH
76 (void *)offsetof(transport_instance, add_headers) },
77 { "headers_only", opt_bool|opt_public,
78 (void *)offsetof(transport_instance, headers_only) },
846726c5 79 { "headers_remove", opt_stringptr|opt_public|opt_rep_str,
059ec3d9
PH
80 (void *)offsetof(transport_instance, remove_headers) },
81 { "headers_rewrite", opt_rewrite|opt_public,
82 (void *)offsetof(transport_instance, headers_rewrite) },
83 { "home_directory", opt_stringptr|opt_public,
84 (void *)offsetof(transport_instance, home_dir) },
85 { "initgroups", opt_bool|opt_public,
86 (void *)offsetof(transport_instance, initgroups) },
fa41615d
JH
87 { "max_parallel", opt_stringptr|opt_public,
88 (void *)offsetof(transport_instance, max_parallel) },
059ec3d9
PH
89 { "message_size_limit", opt_stringptr|opt_public,
90 (void *)offsetof(transport_instance, message_size_limit) },
91 { "rcpt_include_affixes", opt_bool|opt_public,
92 (void *)offsetof(transport_instance, rcpt_include_affixes) },
93 { "retry_use_local_part", opt_bool|opt_public,
94 (void *)offsetof(transport_instance, retry_use_local_part) },
95 { "return_path", opt_stringptr|opt_public,
96 (void *)(offsetof(transport_instance, return_path)) },
97 { "return_path_add", opt_bool|opt_public,
98 (void *)(offsetof(transport_instance, return_path_add)) },
99 { "shadow_condition", opt_stringptr|opt_public,
100 (void *)offsetof(transport_instance, shadow_condition) },
101 { "shadow_transport", opt_stringptr|opt_public,
102 (void *)offsetof(transport_instance, shadow) },
103 { "transport_filter", opt_stringptr|opt_public,
104 (void *)offsetof(transport_instance, filter_command) },
105 { "transport_filter_timeout", opt_time|opt_public,
106 (void *)offsetof(transport_instance, filter_timeout) },
107 { "user", opt_expand_uid|opt_public,
108 (void *)offsetof(transport_instance, uid) }
109};
110
111int optionlist_transports_size =
112 sizeof(optionlist_transports)/sizeof(optionlist);
113
114
115/*************************************************
116* Initialize transport list *
117*************************************************/
118
119/* Read the transports section of the configuration file, and set up a chain of
120transport instances according to its contents. Each transport has generic
121options and may also have its own private options. This function is only ever
122called when transports == NULL. We use generic code in readconf to do most of
123the work. */
124
125void
126transport_init(void)
127{
128transport_instance *t;
129
130readconf_driver_init(US"transport",
131 (driver_instance **)(&transports), /* chain anchor */
132 (driver_info *)transports_available, /* available drivers */
133 sizeof(transport_info), /* size of info block */
134 &transport_defaults, /* default values for generic options */
135 sizeof(transport_instance), /* size of instance block */
136 optionlist_transports, /* generic options */
137 optionlist_transports_size);
138
139/* Now scan the configured transports and check inconsistencies. A shadow
140transport is permitted only for local transports. */
141
142for (t = transports; t != NULL; t = t->next)
143 {
144 if (!t->info->local)
145 {
146 if (t->shadow != NULL)
147 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
148 "shadow transport not allowed on non-local transport %s", t->name);
149 }
150
151 if (t->body_only && t->headers_only)
152 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
153 "%s transport: body_only and headers_only are mutually exclusive",
154 t->name);
155 }
156}
157
158
159
160/*************************************************
161* Write block of data *
162*************************************************/
163
164/* Subroutine called by write_chunk() and at the end of the message actually
165to write a data block. Also called directly by some transports to write
166additional data to the file descriptor (e.g. prefix, suffix).
167
168If a transport wants data transfers to be timed, it sets a non-zero value in
169transport_write_timeout. A non-zero transport_write_timeout causes a timer to
170be set for each block of data written from here. If time runs out, then write()
171fails and provokes an error return. The caller can then inspect sigalrm_seen to
172check for a timeout.
173
174On some systems, if a quota is exceeded during the write, the yield is the
175number of bytes written rather than an immediate error code. This also happens
176on some systems in other cases, for example a pipe that goes away because the
177other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
178get the error codes the first time.
179
180The write() function is also interruptible; the Solaris 2.6 man page says:
181
182 If write() is interrupted by a signal before it writes any
183 data, it will return -1 with errno set to EINTR.
184
185 If write() is interrupted by a signal after it successfully
186 writes some data, it will return the number of bytes written.
187
188To handle these cases, we want to restart the write() to output the remainder
189of the data after a non-negative return from write(), except after a timeout.
190In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
191proper error then occurs. In principle, after an interruption, the second
192write() could suffer the same fate, but we do not want to continue for
193evermore, so stick a maximum repetition count on the loop to act as a
194longstop.
195
196Arguments:
197 fd file descriptor to write to
198 block block of bytes to write
199 len number of bytes to write
200
201Returns: TRUE on success, FALSE on failure (with errno preserved);
202 transport_count is incremented by the number of bytes written
203*/
204
205BOOL
206transport_write_block(int fd, uschar *block, int len)
207{
208int i, rc, save_errno;
958541e9
PH
209int local_timeout = transport_write_timeout;
210
211/* This loop is for handling incomplete writes and other retries. In most
212normal cases, it is only ever executed once. */
059ec3d9
PH
213
214for (i = 0; i < 100; i++)
215 {
216 DEBUG(D_transport)
217 debug_printf("writing data block fd=%d size=%d timeout=%d\n",
958541e9 218 fd, len, local_timeout);
059ec3d9 219
958541e9
PH
220 /* This code makes use of alarm() in order to implement the timeout. This
221 isn't a very tidy way of doing things. Using non-blocking I/O with select()
222 provides a neater approach. However, I don't know how to do this when TLS is
223 in use. */
059ec3d9 224
958541e9
PH
225 if (transport_write_timeout <= 0) /* No timeout wanted */
226 {
227 #ifdef SUPPORT_TLS
817d9f57 228 if (tls_out.active == fd) rc = tls_write(FALSE, block, len); else
958541e9
PH
229 #endif
230 rc = write(fd, block, len);
231 save_errno = errno;
232 }
059ec3d9 233
958541e9 234 /* Timeout wanted. */
059ec3d9 235
958541e9 236 else
059ec3d9 237 {
958541e9
PH
238 alarm(local_timeout);
239 #ifdef SUPPORT_TLS
817d9f57 240 if (tls_out.active == fd) rc = tls_write(FALSE, block, len); else
958541e9
PH
241 #endif
242 rc = write(fd, block, len);
243 save_errno = errno;
244 local_timeout = alarm(0);
059ec3d9
PH
245 if (sigalrm_seen)
246 {
247 errno = ETIMEDOUT;
248 return FALSE;
249 }
250 }
251
252 /* Hopefully, the most common case is success, so test that first. */
253
254 if (rc == len) { transport_count += len; return TRUE; }
255
958541e9
PH
256 /* A non-negative return code is an incomplete write. Try again for the rest
257 of the block. If we have exactly hit the timeout, give up. */
059ec3d9
PH
258
259 if (rc >= 0)
260 {
261 len -= rc;
262 block += rc;
263 transport_count += rc;
264 DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
958541e9 265 goto CHECK_TIMEOUT; /* A few lines below */
059ec3d9
PH
266 }
267
268 /* A negative return code with an EINTR error is another form of
269 incomplete write, zero bytes having been written */
270
271 if (save_errno == EINTR)
272 {
273 DEBUG(D_transport)
274 debug_printf("write interrupted before anything written\n");
958541e9 275 goto CHECK_TIMEOUT; /* A few lines below */
059ec3d9
PH
276 }
277
278 /* A response of EAGAIN from write() is likely only in the case of writing
279 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
280
281 if (save_errno == EAGAIN)
282 {
283 DEBUG(D_transport)
284 debug_printf("write temporarily locked out, waiting 1 sec\n");
285 sleep(1);
958541e9
PH
286
287 /* Before continuing to try another write, check that we haven't run out of
288 time. */
289
290 CHECK_TIMEOUT:
291 if (transport_write_timeout > 0 && local_timeout <= 0)
292 {
293 errno = ETIMEDOUT;
294 return FALSE;
295 }
059ec3d9
PH
296 continue;
297 }
298
299 /* Otherwise there's been an error */
300
301 DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
302 strerror(save_errno));
303 errno = save_errno;
304 return FALSE;
305 }
306
307/* We've tried and tried and tried but still failed */
308
309errno = ERRNO_WRITEINCOMPLETE;
310return FALSE;
311}
312
313
314
315
316/*************************************************
317* Write formatted string *
318*************************************************/
319
320/* This is called by various transports. It is a convenience function.
321
322Arguments:
323 fd file descriptor
324 format string format
325 ... arguments for format
326
327Returns: the yield of transport_write_block()
328*/
329
330BOOL
1ba28e2b 331transport_write_string(int fd, const char *format, ...)
059ec3d9
PH
332{
333va_list ap;
334va_start(ap, format);
335if (!string_vformat(big_buffer, big_buffer_size, format, ap))
336 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
337va_end(ap);
338return transport_write_block(fd, big_buffer, Ustrlen(big_buffer));
339}
340
341
342
343
344/*************************************************
345* Write character chunk *
346*************************************************/
347
348/* Subroutine used by transport_write_message() to scan character chunks for
349newlines and act appropriately. The object is to minimise the number of writes.
350The output byte stream is buffered up in deliver_out_buffer, which is written
351only when it gets full, thus minimizing write operations and TCP packets.
352
353Static data is used to handle the case when the last character of the previous
354chunk was NL, or matched part of the data that has to be escaped.
355
356Arguments:
357 fd file descript to write to
358 chunk pointer to data to write
359 len length of data to write
360 usr_crlf TRUE if CR LF is wanted at the end of each line
361
362In addition, the static nl_xxx variables must be set as required.
363
364Returns: TRUE on success, FALSE on failure (with errno preserved)
365*/
366
367static BOOL
368write_chunk(int fd, uschar *chunk, int len, BOOL use_crlf)
369{
370uschar *start = chunk;
371uschar *end = chunk + len;
ff5aac2b 372uschar *ptr;
059ec3d9
PH
373int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
374
375/* The assumption is made that the check string will never stretch over move
376than one chunk since the only time there are partial matches is when copying
377the body in large buffers. There is always enough room in the buffer for an
378escape string, since the loop below ensures this for each character it
379processes, and it won't have stuck in the escape string if it left a partial
380match. */
381
382if (nl_partial_match >= 0)
383 {
384 if (nl_check_length > 0 && len >= nl_check_length &&
385 Ustrncmp(start, nl_check + nl_partial_match,
386 nl_check_length - nl_partial_match) == 0)
387 {
388 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
389 chunk_ptr += nl_escape_length;
390 start += nl_check_length - nl_partial_match;
391 }
392
393 /* The partial match was a false one. Insert the characters carried over
394 from the previous chunk. */
395
396 else if (nl_partial_match > 0)
397 {
398 Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
399 chunk_ptr += nl_partial_match;
400 }
401
402 nl_partial_match = -1;
403 }
404
405/* Now process the characters in the chunk. Whenever we hit a newline we check
406for possible escaping. The code for the non-NL route should be as fast as
407possible. */
408
409for (ptr = start; ptr < end; ptr++)
410 {
ff5aac2b 411 int ch;
059ec3d9
PH
412
413 /* Flush the buffer if it has reached the threshold - we want to leave enough
414 room for the next uschar, plus a possible extra CR for an LF, plus the escape
415 string. */
416
417 if (chunk_ptr - deliver_out_buffer > mlen)
418 {
419 if (!transport_write_block(fd, deliver_out_buffer,
420 chunk_ptr - deliver_out_buffer))
421 return FALSE;
422 chunk_ptr = deliver_out_buffer;
423 }
424
425 if ((ch = *ptr) == '\n')
426 {
427 int left = end - ptr - 1; /* count of chars left after NL */
428
429 /* Insert CR before NL if required */
430
431 if (use_crlf) *chunk_ptr++ = '\r';
432 *chunk_ptr++ = '\n';
332f5cf3 433 transport_newlines++;
059ec3d9
PH
434
435 /* The check_string test (formerly "from hack") replaces the specific
436 string at the start of a line with an escape string (e.g. "From " becomes
437 ">From " or "." becomes "..". It is a case-sensitive test. The length
438 check above ensures there is always enough room to insert this string. */
439
440 if (nl_check_length > 0)
441 {
442 if (left >= nl_check_length &&
443 Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
444 {
445 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
446 chunk_ptr += nl_escape_length;
447 ptr += nl_check_length;
448 }
449
450 /* Handle the case when there isn't enough left to match the whole
451 check string, but there may be a partial match. We remember how many
452 characters matched, and finish processing this chunk. */
453
454 else if (left <= 0) nl_partial_match = 0;
455
456 else if (Ustrncmp(ptr+1, nl_check, left) == 0)
457 {
458 nl_partial_match = left;
459 ptr = end;
460 }
461 }
462 }
463
464 /* Not a NL character */
465
466 else *chunk_ptr++ = ch;
467 }
468
469return TRUE;
470}
471
472
473
474
475/*************************************************
476* Generate address for RCPT TO *
477*************************************************/
478
479/* This function puts together an address for RCPT to, using the caseful
480version of the local part and the caseful version of the domain. If there is no
481prefix or suffix, or if affixes are to be retained, we can just use the
482original address. Otherwise, if there is a prefix but no suffix we can use a
483pointer into the original address. If there is a suffix, however, we have to
484build a new string.
485
486Arguments:
487 addr the address item
488 include_affixes TRUE if affixes are to be included
489
490Returns: a string
491*/
492
493uschar *
494transport_rcpt_address(address_item *addr, BOOL include_affixes)
495{
496uschar *at;
497int plen, slen;
498
499if (include_affixes)
500 {
501 setflag(addr, af_include_affixes); /* Affects logged => line */
502 return addr->address;
503 }
504
505if (addr->suffix == NULL)
506 {
507 if (addr->prefix == NULL) return addr->address;
508 return addr->address + Ustrlen(addr->prefix);
509 }
510
511at = Ustrrchr(addr->address, '@');
512plen = (addr->prefix == NULL)? 0 : Ustrlen(addr->prefix);
513slen = Ustrlen(addr->suffix);
514
515return string_sprintf("%.*s@%s", (at - addr->address - plen - slen),
516 addr->address + plen, at + 1);
517}
518
519
520/*************************************************
521* Output Envelope-To: address & scan duplicates *
522*************************************************/
523
524/* This function is called from internal_transport_write_message() below, when
525generating an Envelope-To: header line. It checks for duplicates of the given
526address and its ancestors. When one is found, this function calls itself
527recursively, to output the envelope address of the duplicate.
528
529We want to avoid duplication in the list, which can arise for example when
530A->B,C and then both B and C alias to D. This can also happen when there are
531unseen drivers in use. So a list of addresses that have been output is kept in
532the plist variable.
533
534It is also possible to have loops in the address ancestry/duplication graph,
535for example if there are two top level addresses A and B and we have A->B,C and
536B->A. To break the loop, we use a list of processed addresses in the dlist
537variable.
538
539After handling duplication, this function outputs the progenitor of the given
540address.
541
542Arguments:
543 p the address we are interested in
544 pplist address of anchor of the list of addresses not to output
545 pdlist address of anchor of the list of processed addresses
546 first TRUE if this is the first address; set it FALSE afterwards
547 fd the file descriptor to write to
548 use_crlf to be passed on to write_chunk()
549
550Returns: FALSE if writing failed
551*/
552
553static BOOL
554write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
555 BOOL *first, int fd, BOOL use_crlf)
556{
557address_item *pp;
558struct aci *ppp;
559
560/* Do nothing if we have already handled this address. If not, remember it
561so that we don't handle it again. */
562
ff5aac2b 563for (ppp = *pdlist; ppp; ppp = ppp->next) if (p == ppp->ptr) return TRUE;
059ec3d9
PH
564
565ppp = store_get(sizeof(struct aci));
566ppp->next = *pdlist;
567*pdlist = ppp;
568ppp->ptr = p;
569
570/* Now scan up the ancestry, checking for duplicates at each generation. */
571
572for (pp = p;; pp = pp->parent)
573 {
574 address_item *dup;
ff5aac2b
JH
575 for (dup = addr_duplicate; dup; dup = dup->next)
576 if (dup->dupof == pp) /* a dup of our address */
577 if (!write_env_to(dup, pplist, pdlist, first, fd, use_crlf))
578 return FALSE;
579 if (!pp->parent) break;
059ec3d9
PH
580 }
581
582/* Check to see if we have already output the progenitor. */
583
ff5aac2b
JH
584for (ppp = *pplist; ppp; ppp = ppp->next) if (pp == ppp->ptr) break;
585if (ppp) return TRUE;
059ec3d9
PH
586
587/* Remember what we have output, and output it. */
588
589ppp = store_get(sizeof(struct aci));
590ppp->next = *pplist;
591*pplist = ppp;
592ppp->ptr = pp;
593
594if (!(*first) && !write_chunk(fd, US",\n ", 3, use_crlf)) return FALSE;
595*first = FALSE;
596return write_chunk(fd, pp->address, Ustrlen(pp->address), use_crlf);
597}
598
599
600
601
511a6c14
JH
602/* Add/remove/rewwrite headers, and send them plus the empty-line sparator.
603
604Globals:
605 header_list
606
607Arguments:
608 addr (chain of) addresses (for extra headers), or NULL;
609 only the first address is used
610 fd file descriptor to write the message to
611 sendfn function for output
612 use_crlf turn NL into CR LF
613 rewrite_rules chain of header rewriting rules
614 rewrite_existflags flags for the rewriting rules
615
616Returns: TRUE on success; FALSE on failure.
617*/
618BOOL
619transport_headers_send(address_item *addr, int fd, uschar *add_headers, uschar *remove_headers,
620 BOOL (*sendfn)(int fd, uschar * s, int len, BOOL use_crlf),
621 BOOL use_crlf, rewrite_rule *rewrite_rules, int rewrite_existflags)
622{
623header_line *h;
624
625/* Then the message's headers. Don't write any that are flagged as "old";
626that means they were rewritten, or are a record of envelope rewriting, or
627were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
76146973
JH
628match any entries therein. It is a colon-sep list; expand the items
629separately and squash any empty ones.
d43cbe25 630Then check addr->prop.remove_headers too, provided that addr is not NULL. */
511a6c14 631
ff5aac2b 632for (h = header_list; h; h = h->next) if (h->type != htype_old)
511a6c14
JH
633 {
634 int i;
55414b25 635 const uschar *list = remove_headers;
511a6c14
JH
636
637 BOOL include_header = TRUE;
638
d43cbe25 639 for (i = 0; i < 2; i++) /* For remove_headers && addr->prop.remove_headers */
511a6c14
JH
640 {
641 if (list)
642 {
643 int sep = ':'; /* This is specified as a colon-separated list */
644 uschar *s, *ss;
8bc732e8 645 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
511a6c14 646 {
76146973
JH
647 int len;
648
649 if (i == 0)
650 if (!(s = expand_string(s)) && !expand_string_forcedfail)
651 {
652 errno = ERRNO_CHHEADER_FAIL;
653 return FALSE;
654 }
d4ff61d1 655 len = s ? Ustrlen(s) : 0;
511a6c14
JH
656 if (strncmpic(h->text, s, len) != 0) continue;
657 ss = h->text + len;
658 while (*ss == ' ' || *ss == '\t') ss++;
659 if (*ss == ':') break;
660 }
661 if (s != NULL) { include_header = FALSE; break; }
662 }
d43cbe25 663 if (addr != NULL) list = addr->prop.remove_headers;
511a6c14
JH
664 }
665
666 /* If this header is to be output, try to rewrite it if there are rewriting
667 rules. */
668
669 if (include_header)
670 {
671 if (rewrite_rules)
672 {
673 void *reset_point = store_get(0);
674 header_line *hh;
675
676 if ((hh = rewrite_header(h, NULL, NULL, rewrite_rules, rewrite_existflags, FALSE)))
677 {
678 if (!sendfn(fd, hh->text, hh->slen, use_crlf)) return FALSE;
679 store_reset(reset_point);
680 continue; /* With the next header line */
681 }
682 }
683
684 /* Either no rewriting rules, or it didn't get rewritten */
685
686 if (!sendfn(fd, h->text, h->slen, use_crlf)) return FALSE;
687 }
688
689 /* Header removed */
690
691 else
692 {
693 DEBUG(D_transport) debug_printf("removed header line:\n%s---\n", h->text);
694 }
695 }
696
697/* Add on any address-specific headers. If there are multiple addresses,
698they will all have the same headers in order to be batched. The headers
699are chained in reverse order of adding (so several addresses from the
700same alias might share some of them) but we want to output them in the
701opposite order. This is a bit tedious, but there shouldn't be very many
702of them. We just walk the list twice, reversing the pointers each time,
703but on the second time, write out the items.
704
705Headers added to an address by a router are guaranteed to end with a newline.
706*/
707
708if (addr)
709 {
710 int i;
d43cbe25 711 header_line *hprev = addr->prop.extra_headers;
511a6c14
JH
712 header_line *hnext;
713 for (i = 0; i < 2; i++)
ff5aac2b 714 for (h = hprev, hprev = NULL; h; h = hnext)
511a6c14
JH
715 {
716 hnext = h->next;
717 h->next = hprev;
718 hprev = h;
719 if (i == 1)
720 {
721 if (!sendfn(fd, h->text, h->slen, use_crlf)) return FALSE;
722 DEBUG(D_transport)
723 debug_printf("added header line(s):\n%s---\n", h->text);
724 }
725 }
511a6c14
JH
726 }
727
76146973
JH
728/* If a string containing additional headers exists it is a newline-sep
729list. Expand each item and write out the result. This is done last so that
730if it (deliberately or accidentally) isn't in header format, it won't mess
731up any other headers. An empty string or a forced expansion failure are
732noops. An added header string from a transport may not end with a newline;
733add one if it does not. */
511a6c14
JH
734
735if (add_headers)
736 {
76146973
JH
737 int sep = '\n';
738 uschar * s;
739
55414b25 740 while ((s = string_nextinlist(CUSS &add_headers, &sep, NULL, 0)))
ff5aac2b 741 if ((s = expand_string(s)))
76146973
JH
742 {
743 int len = Ustrlen(s);
744 if (len > 0)
511a6c14 745 {
76146973
JH
746 if (!sendfn(fd, s, len, use_crlf)) return FALSE;
747 if (s[len-1] != '\n' && !sendfn(fd, US"\n", 1, use_crlf))
748 return FALSE;
749 DEBUG(D_transport)
750 {
751 debug_printf("added header line:\n%s", s);
752 if (s[len-1] != '\n') debug_printf("\n");
753 debug_printf("---\n");
754 }
511a6c14
JH
755 }
756 }
ff5aac2b
JH
757 else if (!expand_string_forcedfail)
758 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
511a6c14
JH
759 }
760
761/* Separate headers from body with a blank line */
762
763return sendfn(fd, US"\n", 1, use_crlf);
764}
765
766
059ec3d9
PH
767/*************************************************
768* Write the message *
769*************************************************/
770
771/* This function writes the message to the given file descriptor. The headers
772are in the in-store data structure, and the rest of the message is in the open
773file descriptor deliver_datafile. Make sure we start it at the beginning.
774
775. If add_return_path is TRUE, a "return-path:" header is added to the message,
776 containing the envelope sender's address.
777
778. If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
779 giving the top-level envelope address that caused this delivery to happen.
780
781. If add_delivery_date is TRUE, a "delivery-date:" header is added to the
782 message. It gives the time and date that delivery took place.
783
784. If check_string is not null, the start of each line is checked for that
785 string. If it is found, it is replaced by escape_string. This used to be
786 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
787
788. If use_crlf is true, newlines are turned into CRLF (SMTP output).
789
790The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
791any writing or reading error, leaving the code in errno intact. Error exits
792can include timeouts for certain transports, which are requested by setting
793transport_write_timeout non-zero.
794
795Arguments:
796 addr (chain of) addresses (for extra headers), or NULL;
797 only the first address is used
798 fd file descriptor to write the message to
799 options bit-wise options:
800 add_return_path if TRUE, add a "return-path" header
801 add_envelope_to if TRUE, add a "envelope-to" header
802 add_delivery_date if TRUE, add a "delivery-date" header
803 use_crlf if TRUE, turn NL into CR LF
804 end_dot if TRUE, send a terminating "." line at the end
805 no_headers if TRUE, omit the headers
806 no_body if TRUE, omit the body
807 size_limit if > 0, this is a limit to the size of message written;
808 it is used when returning messages to their senders,
809 and is approximate rather than exact, owing to chunk
810 buffering
811 add_headers a string containing one or more headers to add; it is
812 expanded, and must be in correct RFC 822 format as
813 it is transmitted verbatim; NULL => no additions,
814 and so does empty string or forced expansion fail
815 remove_headers a colon-separated list of headers to remove, or NULL
816 check_string a string to check for at the start of lines, or NULL
817 escape_string a string to insert in front of any check string
818 rewrite_rules chain of header rewriting rules
819 rewrite_existflags flags for the rewriting rules
820
821Returns: TRUE on success; FALSE (with errno) on failure.
822 In addition, the global variable transport_count
823 is incremented by the number of bytes written.
824*/
825
826static BOOL
827internal_transport_write_message(address_item *addr, int fd, int options,
828 int size_limit, uschar *add_headers, uschar *remove_headers, uschar *check_string,
829 uschar *escape_string, rewrite_rule *rewrite_rules, int rewrite_existflags)
830{
831int written = 0;
832int len;
059ec3d9
PH
833BOOL use_crlf = (options & topt_use_crlf) != 0;
834
835/* Initialize pointer in output buffer. */
836
837chunk_ptr = deliver_out_buffer;
838
839/* Set up the data for start-of-line data checking and escaping */
840
841nl_partial_match = -1;
ff5aac2b 842if (check_string && escape_string)
059ec3d9
PH
843 {
844 nl_check = check_string;
845 nl_check_length = Ustrlen(nl_check);
846 nl_escape = escape_string;
847 nl_escape_length = Ustrlen(nl_escape);
848 }
ff5aac2b
JH
849else
850 nl_check_length = nl_escape_length = 0;
059ec3d9
PH
851
852/* Whether the escaping mechanism is applied to headers or not is controlled by
853an option (set for SMTP, not otherwise). Negate the length if not wanted till
854after the headers. */
855
ff5aac2b
JH
856if (!(options & topt_escape_headers))
857 nl_check_length = -nl_check_length;
059ec3d9
PH
858
859/* Write the headers if required, including any that have to be added. If there
860are header rewriting rules, apply them. */
861
ff5aac2b 862if (!(options & topt_no_headers))
059ec3d9
PH
863 {
864 /* Add return-path: if requested. */
865
ff5aac2b 866 if (options & topt_add_return_path)
059ec3d9
PH
867 {
868 uschar buffer[ADDRESS_MAXLENGTH + 20];
ff5aac2b 869 int n = sprintf(CS buffer, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH,
059ec3d9 870 return_path);
ff5aac2b 871 if (!write_chunk(fd, buffer, n, use_crlf)) return FALSE;
059ec3d9
PH
872 }
873
874 /* Add envelope-to: if requested */
875
ff5aac2b 876 if (options & topt_add_envelope_to)
059ec3d9
PH
877 {
878 BOOL first = TRUE;
879 address_item *p;
880 struct aci *plist = NULL;
881 struct aci *dlist = NULL;
882 void *reset_point = store_get(0);
883
884 if (!write_chunk(fd, US"Envelope-to: ", 13, use_crlf)) return FALSE;
885
886 /* Pick up from all the addresses. The plist and dlist variables are
887 anchors for lists of addresses already handled; they have to be defined at
888 this level becuase write_env_to() calls itself recursively. */
889
ff5aac2b
JH
890 for (p = addr; p; p = p->next)
891 if (!write_env_to(p, &plist, &dlist, &first, fd, use_crlf))
892 return FALSE;
059ec3d9
PH
893
894 /* Add a final newline and reset the store used for tracking duplicates */
895
896 if (!write_chunk(fd, US"\n", 1, use_crlf)) return FALSE;
897 store_reset(reset_point);
898 }
899
900 /* Add delivery-date: if requested. */
901
902 if ((options & topt_add_delivery_date) != 0)
903 {
904 uschar buffer[100];
ff5aac2b
JH
905 int n = sprintf(CS buffer, "Delivery-date: %s\n", tod_stamp(tod_full));
906 if (!write_chunk(fd, buffer, n, use_crlf)) return FALSE;
059ec3d9
PH
907 }
908
909 /* Then the message's headers. Don't write any that are flagged as "old";
910 that means they were rewritten, or are a record of envelope rewriting, or
911 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
d43cbe25 912 match any entries therein. Then check addr->prop.remove_headers too, provided that
059ec3d9 913 addr is not NULL. */
511a6c14
JH
914 if (!transport_headers_send(addr, fd, add_headers, remove_headers, &write_chunk,
915 use_crlf, rewrite_rules, rewrite_existflags))
916 return FALSE;
059ec3d9
PH
917 }
918
919/* If the body is required, ensure that the data for check strings (formerly
920the "from hack") is enabled by negating the length if necessary. (It will be
921negative in cases where it isn't to apply to the headers). Then ensure the body
922is positioned at the start of its file (following the message id), then write
923it, applying the size limit if required. */
924
ff5aac2b 925if (!(options & topt_no_body))
059ec3d9
PH
926 {
927 nl_check_length = abs(nl_check_length);
928 nl_partial_match = 0;
d4ff61d1
JH
929 if (lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET) < 0)
930 return FALSE;
059ec3d9
PH
931 while ((len = read(deliver_datafile, deliver_in_buffer,
932 DELIVER_IN_BUFFER_SIZE)) > 0)
933 {
934 if (!write_chunk(fd, deliver_in_buffer, len, use_crlf)) return FALSE;
935 if (size_limit > 0)
936 {
937 written += len;
938 if (written > size_limit)
939 {
940 len = 0; /* Pretend EOF */
941 break;
942 }
943 }
944 }
945
059ec3d9
PH
946 /* A read error on the body will have left len == -1 and errno set. */
947
948 if (len != 0) return FALSE;
c0940526 949 }
059ec3d9 950
c0940526 951/* Finished with the check string */
059ec3d9 952
c0940526
PP
953nl_check_length = nl_escape_length = 0;
954
955/* If requested, add a terminating "." line (SMTP output). */
956
ff5aac2b 957if (options & topt_end_dot && !write_chunk(fd, US".\n", 2, use_crlf))
c0940526 958 return FALSE;
059ec3d9
PH
959
960/* Write out any remaining data in the buffer before returning. */
961
962return (len = chunk_ptr - deliver_out_buffer) <= 0 ||
963 transport_write_block(fd, deliver_out_buffer, len);
964}
965
966
80a47a2c 967#ifndef DISABLE_DKIM
fb2274d4 968
4cd12fe9
TK
969/***************************************************************************************************
970* External interface to write the message, while signing it with DKIM and/or Domainkeys *
971***************************************************************************************************/
fb2274d4 972
077ba943
JH
973/* This function is a wrapper around transport_write_message().
974 It is only called from the smtp transport if DKIM or Domainkeys support
975 is compiled in. The function sets up a replacement fd into a -K file,
976 then calls the normal function. This way, the exact bits that exim would
977 have put "on the wire" will end up in the file (except for TLS
978 encapsulation, which is the very very last thing). When we are done
979 signing the file, send the signed message down the original fd (or TLS fd).
980
981Arguments:
ff5aac2b
JH
982 as for internal_transport_write_message() above, with additional arguments
983 for DKIM.
f7572e5a
TK
984
985Returns: TRUE on success; FALSE (with errno) for any failure
986*/
987
988BOOL
ff5aac2b
JH
989dkim_transport_write_message(address_item *addr, int out_fd, int options,
990 uschar *add_headers, uschar *remove_headers,
f7572e5a 991 uschar *check_string, uschar *escape_string, rewrite_rule *rewrite_rules,
ff5aac2b 992 int rewrite_existflags, struct ob_dkim * dkim)
f7572e5a 993{
077ba943
JH
994int dkim_fd;
995int save_errno = 0;
996BOOL rc;
41313d92 997uschar * dkim_spool_name;
077ba943
JH
998int sread = 0;
999int wwritten = 0;
1000uschar *dkim_signature = NULL;
ff5aac2b 1001off_t k_file_size;
077ba943
JH
1002
1003/* If we can't sign, just call the original function. */
1004
ff5aac2b
JH
1005if (!(dkim->dkim_private_key && dkim->dkim_domain && dkim->dkim_selector))
1006 return transport_write_message(addr, out_fd, options,
1007 0, add_headers, remove_headers,
077ba943
JH
1008 check_string, escape_string, rewrite_rules,
1009 rewrite_existflags);
1010
41313d92
JH
1011dkim_spool_name = spool_fname(US"input", message_subdir, message_id,
1012 string_sprintf("-%d-K", (int)getpid()));
077ba943
JH
1013
1014if ((dkim_fd = Uopen(dkim_spool_name, O_RDWR|O_CREAT|O_TRUNC, SPOOL_MODE)) < 0)
1015 {
1016 /* Can't create spool file. Ugh. */
1017 rc = FALSE;
1018 save_errno = errno;
1019 goto CLEANUP;
4cd12fe9
TK
1020 }
1021
ff5aac2b 1022/* Call original function to write the -K file; does the CRLF expansion */
f7572e5a 1023
077ba943 1024rc = transport_write_message(addr, dkim_fd, options,
ff5aac2b 1025 0, add_headers, remove_headers,
077ba943
JH
1026 check_string, escape_string, rewrite_rules,
1027 rewrite_existflags);
f7572e5a 1028
077ba943
JH
1029/* Save error state. We must clean up before returning. */
1030if (!rc)
1031 {
1032 save_errno = errno;
1033 goto CLEANUP;
1034 }
f7572e5a 1035
ff5aac2b 1036if (dkim->dkim_private_key && dkim->dkim_domain && dkim->dkim_selector)
077ba943
JH
1037 {
1038 /* Rewind file and feed it to the goats^W DKIM lib */
1039 lseek(dkim_fd, 0, SEEK_SET);
1040 dkim_signature = dkim_exim_sign(dkim_fd,
ff5aac2b
JH
1041 dkim->dkim_private_key,
1042 dkim->dkim_domain,
1043 dkim->dkim_selector,
1044 dkim->dkim_canon,
1045 dkim->dkim_sign_headers);
077ba943
JH
1046 if (!dkim_signature)
1047 {
ff5aac2b 1048 if (dkim->dkim_strict)
077ba943 1049 {
ff5aac2b 1050 uschar *dkim_strict_result = expand_string(dkim->dkim_strict);
077ba943 1051 if (dkim_strict_result)
ff5aac2b
JH
1052 if ( (strcmpic(dkim->dkim_strict,US"1") == 0) ||
1053 (strcmpic(dkim->dkim_strict,US"true") == 0) )
077ba943
JH
1054 {
1055 /* Set errno to something halfway meaningful */
1056 save_errno = EACCES;
1057 log_write(0, LOG_MAIN, "DKIM: message could not be signed,"
1058 " and dkim_strict is set. Deferring message delivery.");
1059 rc = FALSE;
1060 goto CLEANUP;
1061 }
f7572e5a
TK
1062 }
1063 }
ff5aac2b
JH
1064
1065 if (dkim_signature)
077ba943
JH
1066 {
1067 int siglen = Ustrlen(dkim_signature);
1068 while(siglen > 0)
1069 {
ff5aac2b
JH
1070 #ifdef SUPPORT_TLS
1071 wwritten = tls_out.active == out_fd
1072 ? tls_write(FALSE, dkim_signature, siglen)
1073 : write(out_fd, dkim_signature, siglen);
1074 #else
1075 wwritten = write(out_fd, dkim_signature, siglen);
1076 #endif
077ba943 1077 if (wwritten == -1)
ff5aac2b 1078 {
077ba943
JH
1079 /* error, bail out */
1080 save_errno = errno;
1081 rc = FALSE;
1082 goto CLEANUP;
1083 }
1084 siglen -= wwritten;
1085 dkim_signature += wwritten;
f7572e5a
TK
1086 }
1087 }
4cd12fe9 1088 }
f7572e5a 1089
f7572e5a 1090#ifdef HAVE_LINUX_SENDFILE
077ba943
JH
1091/* We can use sendfile() to shove the file contents
1092 to the socket. However only if we don't use TLS,
1093 as then there's another layer of indirection
1094 before the data finally hits the socket. */
ff5aac2b 1095if (tls_out.active != out_fd)
077ba943
JH
1096 {
1097 ssize_t copied = 0;
1098 off_t offset = 0;
e8bc7fca 1099
ff5aac2b
JH
1100 k_file_size = lseek(dkim_fd, 0, SEEK_END); /* Fetch file size */
1101
e8bc7fca
JH
1102 /* Rewind file */
1103 lseek(dkim_fd, 0, SEEK_SET);
1104
ff5aac2b
JH
1105 while(copied >= 0 && offset < k_file_size)
1106 copied = sendfile(out_fd, dkim_fd, &offset, k_file_size - offset);
077ba943 1107 if (copied < 0)
f7572e5a 1108 {
077ba943
JH
1109 save_errno = errno;
1110 rc = FALSE;
f7572e5a 1111 }
077ba943 1112 }
e8bc7fca
JH
1113else
1114
f7572e5a
TK
1115#endif
1116
077ba943 1117 {
e8bc7fca
JH
1118 /* Rewind file */
1119 lseek(dkim_fd, 0, SEEK_SET);
077ba943 1120
e8bc7fca 1121 /* Send file down the original fd */
ff5aac2b 1122 while((sread = read(dkim_fd, deliver_out_buffer, DELIVER_OUT_BUFFER_SIZE)) >0)
f7572e5a 1123 {
ff5aac2b 1124 char *p = deliver_out_buffer;
e8bc7fca
JH
1125 /* write the chunk */
1126
1127 while (sread)
1128 {
077ba943 1129#ifdef SUPPORT_TLS
ff5aac2b 1130 wwritten = tls_out.active == out_fd
e8bc7fca 1131 ? tls_write(FALSE, US p, sread)
ff5aac2b 1132 : write(out_fd, p, sread);
077ba943 1133#else
ff5aac2b 1134 wwritten = write(out_fd, p, sread);
077ba943 1135#endif
e8bc7fca
JH
1136 if (wwritten == -1)
1137 {
1138 /* error, bail out */
1139 save_errno = errno;
1140 rc = FALSE;
1141 goto CLEANUP;
1142 }
1143 p += wwritten;
1144 sread -= wwritten;
f7572e5a 1145 }
f7572e5a
TK
1146 }
1147
e8bc7fca
JH
1148 if (sread == -1)
1149 {
1150 save_errno = errno;
1151 rc = FALSE;
1152 }
077ba943 1153 }
f7572e5a 1154
077ba943
JH
1155CLEANUP:
1156/* unlink -K file */
1157(void)close(dkim_fd);
1158Uunlink(dkim_spool_name);
1159errno = save_errno;
1160return rc;
f7572e5a 1161}
80a47a2c 1162
f7572e5a
TK
1163#endif
1164
1165
1166
059ec3d9
PH
1167/*************************************************
1168* External interface to write the message *
1169*************************************************/
1170
1171/* If there is no filtering required, call the internal function above to do
1172the real work, passing over all the arguments from this function. Otherwise,
1173set up a filtering process, fork another process to call the internal function
1174to write to the filter, and in this process just suck from the filter and write
1175down the given fd. At the end, tidy up the pipes and the processes.
1176
1177Arguments: as for internal_transport_write_message() above
1178
1179Returns: TRUE on success; FALSE (with errno) for any failure
1180 transport_count is incremented by the number of bytes written
1181*/
1182
1183BOOL
1184transport_write_message(address_item *addr, int fd, int options,
1185 int size_limit, uschar *add_headers, uschar *remove_headers,
1186 uschar *check_string, uschar *escape_string, rewrite_rule *rewrite_rules,
1187 int rewrite_existflags)
1188{
1189BOOL use_crlf;
1190BOOL last_filter_was_NL = TRUE;
1191int rc, len, yield, fd_read, fd_write, save_errno;
806c3df9 1192int pfd[2] = {-1, -1};
059ec3d9
PH
1193pid_t filter_pid, write_pid;
1194
2e2a30b4
PH
1195transport_filter_timed_out = FALSE;
1196
059ec3d9
PH
1197/* If there is no filter command set up, call the internal function that does
1198the actual work, passing it the incoming fd, and return its result. */
1199
6ff55e50
JH
1200if ( !transport_filter_argv
1201 || !*transport_filter_argv
1202 || !**transport_filter_argv
1203 )
059ec3d9
PH
1204 return internal_transport_write_message(addr, fd, options, size_limit,
1205 add_headers, remove_headers, check_string, escape_string,
1206 rewrite_rules, rewrite_existflags);
1207
1208/* Otherwise the message must be written to a filter process and read back
1209before being written to the incoming fd. First set up the special processing to
1210be done during the copying. */
1211
1212use_crlf = (options & topt_use_crlf) != 0;
1213nl_partial_match = -1;
1214
1215if (check_string != NULL && escape_string != NULL)
1216 {
1217 nl_check = check_string;
1218 nl_check_length = Ustrlen(nl_check);
1219 nl_escape = escape_string;
1220 nl_escape_length = Ustrlen(nl_escape);
1221 }
1222else nl_check_length = nl_escape_length = 0;
1223
1224/* Start up a subprocess to run the command. Ensure that our main fd will
1225be closed when the subprocess execs, but remove the flag afterwards.
1226(Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1227process to deliver another message.) We get back stdin/stdout file descriptors.
1228If the process creation failed, give an error return. */
1229
1230fd_read = -1;
1231fd_write = -1;
1232save_errno = 0;
1233yield = FALSE;
1234write_pid = (pid_t)(-1);
1235
ff790e47 1236(void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
55414b25
JH
1237filter_pid = child_open(USS transport_filter_argv, NULL, 077,
1238 &fd_write, &fd_read, FALSE);
ff790e47 1239(void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) & ~FD_CLOEXEC);
059ec3d9
PH
1240if (filter_pid < 0) goto TIDY_UP; /* errno set */
1241
1242DEBUG(D_transport)
1243 debug_printf("process %d running as transport filter: write=%d read=%d\n",
1244 (int)filter_pid, fd_write, fd_read);
1245
1246/* Fork subprocess to write the message to the filter, and return the result
1247via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1248smtp dots, or check string processing. */
1249
1250if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1251if ((write_pid = fork()) == 0)
1252 {
1253 BOOL rc;
f1e894f3
PH
1254 (void)close(fd_read);
1255 (void)close(pfd[pipe_read]);
059ec3d9
PH
1256 nl_check_length = nl_escape_length = 0;
1257 rc = internal_transport_write_message(addr, fd_write,
1258 (options & ~(topt_use_crlf | topt_end_dot)),
1259 size_limit, add_headers, remove_headers, NULL, NULL,
1260 rewrite_rules, rewrite_existflags);
1261 save_errno = errno;
1ac6b2e7
JH
1262 if ( write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1263 != sizeof(BOOL)
1264 || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1265 != sizeof(int)
1266 || write(pfd[pipe_write], (void *)&(addr->more_errno), sizeof(int))
1267 != sizeof(int)
1268 )
1269 rc = FALSE; /* compiler quietening */
059ec3d9
PH
1270 _exit(0);
1271 }
1272save_errno = errno;
1273
1274/* Parent process: close our copy of the writing subprocess' pipes. */
1275
f1e894f3
PH
1276(void)close(pfd[pipe_write]);
1277(void)close(fd_write);
059ec3d9
PH
1278fd_write = -1;
1279
1280/* Writing process creation failed */
1281
1282if (write_pid < 0)
1283 {
1284 errno = save_errno; /* restore */
1285 goto TIDY_UP;
1286 }
1287
1288/* When testing, let the subprocess get going */
1289
1290if (running_in_test_harness) millisleep(250);
1291
1292DEBUG(D_transport)
1293 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1294
1295/* Copy the message from the filter to the output fd. A read error leaves len
1296== -1 and errno set. We need to apply a timeout to the read, to cope with
1297the case when the filter gets stuck, but it can be quite a long one. The
1298default is 5m, but this is now configurable. */
1299
1300DEBUG(D_transport) debug_printf("copying from the filter\n");
1301
1302/* Copy the output of the filter, remembering if the last character was NL. If
1303no data is returned, that counts as "ended with NL" (default setting of the
1304variable is TRUE). */
1305
1306chunk_ptr = deliver_out_buffer;
1307
1308for (;;)
1309 {
1310 sigalrm_seen = FALSE;
1311 alarm(transport_filter_timeout);
1312 len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1313 alarm(0);
1314 if (sigalrm_seen)
1315 {
1316 errno = ETIMEDOUT;
2e2a30b4 1317 transport_filter_timed_out = TRUE;
059ec3d9
PH
1318 goto TIDY_UP;
1319 }
1320
1321 /* If the read was successful, write the block down the original fd,
1322 remembering whether it ends in \n or not. */
1323
1324 if (len > 0)
1325 {
1326 if (!write_chunk(fd, deliver_in_buffer, len, use_crlf)) goto TIDY_UP;
1327 last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1328 }
1329
1330 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1331
1332 else
1333 {
1334 if (len == 0) yield = TRUE;
1335 break;
1336 }
1337 }
1338
1339/* Tidying up code. If yield = FALSE there has been an error and errno is set
1340to something. Ensure the pipes are all closed and the processes are removed. If
1341there has been an error, kill the processes before waiting for them, just to be
1342sure. Also apply a paranoia timeout. */
1343
1344TIDY_UP:
1345save_errno = errno;
1346
f1e894f3
PH
1347(void)close(fd_read);
1348if (fd_write > 0) (void)close(fd_write);
059ec3d9
PH
1349
1350if (!yield)
1351 {
1352 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1353 if (write_pid > 0) kill(write_pid, SIGKILL);
1354 }
1355
1356/* Wait for the filter process to complete. */
1357
1358DEBUG(D_transport) debug_printf("waiting for filter process\n");
1359if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1360 {
1361 yield = FALSE;
1362 save_errno = ERRNO_FILTER_FAIL;
1363 addr->more_errno = rc;
1364 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1365 }
1366
1367/* Wait for the writing process to complete. If it ends successfully,
8e669ac1 1368read the results from its pipe, provided we haven't already had a filter
35af9f61 1369process failure. */
059ec3d9
PH
1370
1371DEBUG(D_transport) debug_printf("waiting for writing process\n");
1372if (write_pid > 0)
1373 {
35af9f61
PH
1374 rc = child_close(write_pid, 30);
1375 if (yield)
059ec3d9 1376 {
8e669ac1 1377 if (rc == 0)
35af9f61
PH
1378 {
1379 BOOL ok;
1ac6b2e7 1380 int dummy = read(pfd[pipe_read], (void *)&ok, sizeof(BOOL));
35af9f61
PH
1381 if (!ok)
1382 {
1ac6b2e7
JH
1383 dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1384 dummy = read(pfd[pipe_read], (void *)&(addr->more_errno), sizeof(int));
35af9f61
PH
1385 yield = FALSE;
1386 }
1387 }
1388 else
059ec3d9 1389 {
059ec3d9 1390 yield = FALSE;
35af9f61
PH
1391 save_errno = ERRNO_FILTER_FAIL;
1392 addr->more_errno = rc;
1393 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
059ec3d9 1394 }
8e669ac1 1395 }
059ec3d9 1396 }
f1e894f3 1397(void)close(pfd[pipe_read]);
059ec3d9
PH
1398
1399/* If there have been no problems we can now add the terminating "." if this is
1400SMTP output, turning off escaping beforehand. If the last character from the
1401filter was not NL, insert a NL to make the SMTP protocol work. */
1402
1403if (yield)
1404 {
1405 nl_check_length = nl_escape_length = 0;
ff5aac2b
JH
1406 if ( options & topt_end_dot
1407 && ( last_filter_was_NL
1408 ? !write_chunk(fd, US".\n", 2, options)
1409 : !write_chunk(fd, US"\n.\n", 3, options)
1410 ) )
059ec3d9 1411 yield = FALSE;
059ec3d9
PH
1412
1413 /* Write out any remaining data in the buffer. */
1414
1415 else
ff5aac2b
JH
1416 yield = (len = chunk_ptr - deliver_out_buffer) <= 0
1417 || transport_write_block(fd, deliver_out_buffer, len);
059ec3d9 1418 }
ff5aac2b
JH
1419else
1420 errno = save_errno; /* From some earlier error */
059ec3d9
PH
1421
1422DEBUG(D_transport)
1423 {
1424 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1425 if (!yield)
1426 debug_printf("errno=%d more_errno=%d\n", errno, addr->more_errno);
1427 }
1428
1429return yield;
1430}
1431
1432
1433
1434
1435
1436/*************************************************
1437* Update waiting database *
1438*************************************************/
1439
1440/* This is called when an address is deferred by remote transports that are
1441capable of sending more than one message over one connection. A database is
1442maintained for each transport, keeping track of which messages are waiting for
1443which hosts. The transport can then consult this when eventually a successful
1444delivery happens, and if it finds that another message is waiting for the same
1445host, it can fire up a new process to deal with it using the same connection.
1446
1447The database records are keyed by host name. They can get full if there are
1448lots of messages waiting, and so there is a continuation mechanism for them.
1449
1450Each record contains a list of message ids, packed end to end without any
1451zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1452in this record, and the sequence field says if there are any other records for
1453this host. If the sequence field is 0, there are none. If it is 1, then another
1454record with the name <hostname>:0 exists; if it is 2, then two other records
1455with sequence numbers 0 and 1 exist, and so on.
1456
1457Currently, an exhaustive search of all continuation records has to be done to
1458determine whether to add a message id to a given record. This shouldn't be
1459too bad except in extreme cases. I can't figure out a *simple* way of doing
1460better.
1461
1462Old records should eventually get swept up by the exim_tidydb utility.
1463
1464Arguments:
f6c332bd 1465 hostlist list of hosts that this message could be sent to
059ec3d9
PH
1466 tpname name of the transport
1467
1468Returns: nothing
1469*/
1470
1471void
1472transport_update_waiting(host_item *hostlist, uschar *tpname)
1473{
1474uschar buffer[256];
55414b25 1475const uschar *prevname = US"";
059ec3d9
PH
1476host_item *host;
1477open_db dbblock;
1478open_db *dbm_file;
1479
7a0743eb
PH
1480DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1481
059ec3d9
PH
1482/* Open the database for this transport */
1483
1484sprintf(CS buffer, "wait-%.200s", tpname);
1485dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1486if (dbm_file == NULL) return;
1487
1488/* Scan the list of hosts for which this message is waiting, and ensure
f6c332bd 1489that the message id is in each host record. */
059ec3d9
PH
1490
1491for (host = hostlist; host!= NULL; host = host->next)
1492 {
1493 BOOL already = FALSE;
1494 dbdata_wait *host_record;
1495 uschar *s;
1496 int i, host_length;
1497
059ec3d9
PH
1498 /* Skip if this is the same host as we just processed; otherwise remember
1499 the name for next time. */
1500
1501 if (Ustrcmp(prevname, host->name) == 0) continue;
1502 prevname = host->name;
1503
1504 /* Look up the host record; if there isn't one, make an empty one. */
1505
1506 host_record = dbfn_read(dbm_file, host->name);
1507 if (host_record == NULL)
1508 {
1509 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH);
1510 host_record->count = host_record->sequence = 0;
1511 }
1512
1513 /* Compute the current length */
1514
1515 host_length = host_record->count * MESSAGE_ID_LENGTH;
1516
1517 /* Search the record to see if the current message is already in it. */
1518
1519 for (s = host_record->text; s < host_record->text + host_length;
1520 s += MESSAGE_ID_LENGTH)
1521 {
1522 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1523 { already = TRUE; break; }
1524 }
1525
1526 /* If we haven't found this message in the main record, search any
1527 continuation records that exist. */
1528
1529 for (i = host_record->sequence - 1; i >= 0 && !already; i--)
1530 {
1531 dbdata_wait *cont;
1532 sprintf(CS buffer, "%.200s:%d", host->name, i);
1533 cont = dbfn_read(dbm_file, buffer);
1534 if (cont != NULL)
1535 {
1536 int clen = cont->count * MESSAGE_ID_LENGTH;
1537 for (s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1538 {
1539 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1540 { already = TRUE; break; }
1541 }
1542 }
1543 }
1544
1545 /* If this message is already in a record, no need to update. */
1546
7a0743eb
PH
1547 if (already)
1548 {
1549 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1550 continue;
1551 }
059ec3d9
PH
1552
1553
1554 /* If this record is full, write it out with a new name constructed
1555 from the sequence number, increase the sequence number, and empty
1556 the record. */
1557
1558 if (host_record->count >= WAIT_NAME_MAX)
1559 {
1560 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1561 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1562 host_record->sequence++;
1563 host_record->count = 0;
1564 host_length = 0;
1565 }
1566
1567 /* If this record is not full, increase the size of the record to
1568 allow for one new message id. */
1569
1570 else
1571 {
1572 dbdata_wait *newr =
1573 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH);
1574 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1575 host_record = newr;
1576 }
1577
1578 /* Now add the new name on the end */
1579
1580 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1581 host_record->count++;
1582 host_length += MESSAGE_ID_LENGTH;
1583
1584 /* Update the database */
1585
1586 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
7a0743eb 1587 DEBUG(D_transport) debug_printf("added to list for %s\n", host->name);
059ec3d9
PH
1588 }
1589
1590/* All now done */
1591
1592dbfn_close(dbm_file);
1593}
1594
1595
1596
1597
1598/*************************************************
1599* Test for waiting messages *
1600*************************************************/
1601
1602/* This function is called by a remote transport which uses the previous
1603function to remember which messages are waiting for which remote hosts. It's
1604called after a successful delivery and its job is to check whether there is
1605another message waiting for the same host. However, it doesn't do this if the
1606current continue sequence is greater than the maximum supplied as an argument,
1607or greater than the global connection_max_messages, which, if set, overrides.
1608
1609Arguments:
1610 transport_name name of the transport
1611 hostname name of the host
1612 local_message_max maximum number of messages down one connection
1613 as set by the caller transport
1614 new_message_id set to the message id of a waiting message
1615 more set TRUE if there are yet more messages waiting
a39bd74d
JB
1616 oicf_func function to call to validate if it is ok to send
1617 to this message_id from the current instance.
1618 oicf_data opaque data for oicf_func
059ec3d9
PH
1619
1620Returns: TRUE if new_message_id set; FALSE otherwise
1621*/
1622
a39bd74d
JB
1623typedef struct msgq_s
1624{
1625 uschar message_id [MESSAGE_ID_LENGTH + 1];
1626 BOOL bKeep;
1627} msgq_t;
1628
059ec3d9 1629BOOL
55414b25 1630transport_check_waiting(const uschar *transport_name, const uschar *hostname,
a39bd74d 1631 int local_message_max, uschar *new_message_id, BOOL *more, oicf oicf_func, void *oicf_data)
059ec3d9
PH
1632{
1633dbdata_wait *host_record;
0539a19d 1634int host_length;
059ec3d9
PH
1635open_db dbblock;
1636open_db *dbm_file;
1637uschar buffer[256];
1638
a39bd74d 1639int i;
a39bd74d 1640struct stat statbuf;
a39bd74d 1641
059ec3d9
PH
1642*more = FALSE;
1643
1644DEBUG(D_transport)
1645 {
1646 debug_printf("transport_check_waiting entered\n");
1647 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1648 continue_sequence, local_message_max, connection_max_messages);
1649 }
1650
1651/* Do nothing if we have hit the maximum number that can be send down one
1652connection. */
1653
1654if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1655if (local_message_max > 0 && continue_sequence >= local_message_max)
1656 {
1657 DEBUG(D_transport)
1658 debug_printf("max messages for one connection reached: returning\n");
1659 return FALSE;
1660 }
1661
1662/* Open the waiting information database. */
1663
1664sprintf(CS buffer, "wait-%.200s", transport_name);
1665dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1666if (dbm_file == NULL) return FALSE;
1667
1668/* See if there is a record for this host; if not, there's nothing to do. */
1669
789f8a4f 1670if (!(host_record = dbfn_read(dbm_file, hostname)))
059ec3d9
PH
1671 {
1672 dbfn_close(dbm_file);
1673 DEBUG(D_transport) debug_printf("no messages waiting for %s\n", hostname);
1674 return FALSE;
1675 }
1676
1677/* If the data in the record looks corrupt, just log something and
1678don't try to use it. */
1679
1680if (host_record->count > WAIT_NAME_MAX)
1681 {
1682 dbfn_close(dbm_file);
1683 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1684 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1685 return FALSE;
1686 }
1687
1688/* Scan the message ids in the record from the end towards the beginning,
1689until one is found for which a spool file actually exists. If the record gets
1690emptied, delete it and continue with any continuation records that may exist.
1691*/
1692
a39bd74d
JB
1693/* For Bug 1141, I refactored this major portion of the routine, it is risky
1694but the 1 off will remain without it. This code now allows me to SKIP over
1695a message I do not want to send out on this run. */
059ec3d9 1696
a39bd74d
JB
1697host_length = host_record->count * MESSAGE_ID_LENGTH;
1698
1699while (1)
059ec3d9 1700 {
789f8a4f
JH
1701 msgq_t *msgq;
1702 int msgq_count = 0;
1703 int msgq_actual = 0;
1704 BOOL bFound = FALSE;
1705 BOOL bContinuation = FALSE;
1706
a39bd74d 1707 /* create an array to read entire message queue into memory for processing */
059ec3d9 1708
a39bd74d
JB
1709 msgq = (msgq_t*) malloc(sizeof(msgq_t) * host_record->count);
1710 msgq_count = host_record->count;
1711 msgq_actual = msgq_count;
059ec3d9 1712
a39bd74d 1713 for (i = 0; i < host_record->count; ++i)
059ec3d9 1714 {
a39bd74d
JB
1715 msgq[i].bKeep = TRUE;
1716
1717 Ustrncpy(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
059ec3d9 1718 MESSAGE_ID_LENGTH);
a39bd74d
JB
1719 msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1720 }
1721
1722 /* first thing remove current message id if it exists */
059ec3d9 1723
a39bd74d
JB
1724 for (i = 0; i < msgq_count; ++i)
1725 if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1726 {
1727 msgq[i].bKeep = FALSE;
1728 break;
1729 }
1730
1731 /* now find the next acceptable message_id */
1732
a39bd74d
JB
1733 for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1734 {
41313d92
JH
1735 uschar subdir[2];
1736
1737 subdir[0] = split_spool_directory ? msgq[i].message_id[5] : 0;
1738 subdir[1] = 0;
059ec3d9 1739
41313d92
JH
1740 if (Ustat(spool_fname(US"input", subdir, msgq[i].message_id, US"-D"),
1741 &statbuf) != 0)
a39bd74d
JB
1742 msgq[i].bKeep = FALSE;
1743 else if (!oicf_func || oicf_func(msgq[i].message_id, oicf_data))
059ec3d9 1744 {
a39bd74d
JB
1745 Ustrcpy(new_message_id, msgq[i].message_id);
1746 msgq[i].bKeep = FALSE;
1747 bFound = TRUE;
059ec3d9
PH
1748 break;
1749 }
1750 }
1751
a39bd74d
JB
1752 /* re-count */
1753 for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1754 if (msgq[i].bKeep)
1755 msgq_actual++;
1756
1757 /* reassemble the host record, based on removed message ids, from in
789f8a4f 1758 memory queue */
a39bd74d
JB
1759
1760 if (msgq_actual <= 0)
1761 {
1762 host_length = 0;
1763 host_record->count = 0;
1764 }
1765 else
1766 {
1767 host_length = msgq_actual * MESSAGE_ID_LENGTH;
1768 host_record->count = msgq_actual;
1769
1770 if (msgq_actual < msgq_count)
1771 {
1772 int new_count;
1773 for (new_count = 0, i = 0; i < msgq_count; ++i)
1774 if (msgq[i].bKeep)
1775 Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1776 msgq[i].message_id, MESSAGE_ID_LENGTH);
1777
1778 host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1779 }
1780 }
1781
1782/* Jeremy: check for a continuation record, this code I do not know how to
1783test but the code should work */
1784
059ec3d9
PH
1785 while (host_length <= 0)
1786 {
1787 int i;
a39bd74d 1788 dbdata_wait * newr = NULL;
059ec3d9
PH
1789
1790 /* Search for a continuation */
1791
a39bd74d 1792 for (i = host_record->sequence - 1; i >= 0 && !newr; i--)
059ec3d9
PH
1793 {
1794 sprintf(CS buffer, "%.200s:%d", hostname, i);
1795 newr = dbfn_read(dbm_file, buffer);
1796 }
1797
1798 /* If no continuation, delete the current and break the loop */
1799
a39bd74d 1800 if (!newr)
059ec3d9
PH
1801 {
1802 dbfn_delete(dbm_file, hostname);
1803 break;
1804 }
1805
1806 /* Else replace the current with the continuation */
1807
1808 dbfn_delete(dbm_file, buffer);
1809 host_record = newr;
1810 host_length = host_record->count * MESSAGE_ID_LENGTH;
059ec3d9 1811
a39bd74d
JB
1812 bContinuation = TRUE;
1813 }
059ec3d9 1814
789f8a4f
JH
1815 if (bFound) /* Usual exit from main loop */
1816 {
1817 free (msgq);
a39bd74d 1818 break;
789f8a4f 1819 }
059ec3d9
PH
1820
1821 /* If host_length <= 0 we have emptied a record and not found a good message,
1822 and there are no continuation records. Otherwise there is a continuation
1823 record to process. */
1824
1825 if (host_length <= 0)
1826 {
1827 dbfn_close(dbm_file);
1828 DEBUG(D_transport) debug_printf("waiting messages already delivered\n");
1829 return FALSE;
1830 }
a39bd74d
JB
1831
1832 /* we were not able to find an acceptable message, nor was there a
1833 * continuation record. So bug out, outer logic will clean this up.
1834 */
1835
1836 if (!bContinuation)
1837 {
789f8a4f 1838 Ustrcpy(new_message_id, message_id);
a39bd74d
JB
1839 dbfn_close(dbm_file);
1840 return FALSE;
1841 }
a39bd74d 1842
789f8a4f
JH
1843 free(msgq);
1844 } /* we need to process a continuation record */
059ec3d9
PH
1845
1846/* Control gets here when an existing message has been encountered; its
1847id is in new_message_id, and host_length is the revised length of the
1848host record. If it is zero, the record has been removed. Update the
1849record if required, close the database, and return TRUE. */
1850
1851if (host_length > 0)
1852 {
1853 host_record->count = host_length/MESSAGE_ID_LENGTH;
a39bd74d 1854
059ec3d9
PH
1855 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1856 *more = TRUE;
1857 }
1858
1859dbfn_close(dbm_file);
1860return TRUE;
1861}
1862
059ec3d9
PH
1863/*************************************************
1864* Deliver waiting message down same socket *
1865*************************************************/
1866
1867/* Fork a new exim process to deliver the message, and do a re-exec, both to
1868get a clean delivery process, and to regain root privilege in cases where it
1869has been given away.
1870
1871Arguments:
1872 transport_name to pass to the new process
1873 hostname ditto
1874 hostaddress ditto
1875 id the new message to process
1876 socket_fd the connected socket
1877
1878Returns: FALSE if fork fails; TRUE otherwise
1879*/
1880
1881BOOL
55414b25
JH
1882transport_pass_socket(const uschar *transport_name, const uschar *hostname,
1883 const uschar *hostaddress, uschar *id, int socket_fd)
059ec3d9
PH
1884{
1885pid_t pid;
1886int status;
1887
1888DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
1889
1890if ((pid = fork()) == 0)
1891 {
1892 int i = 16;
55414b25 1893 const uschar **argv;
059ec3d9
PH
1894
1895 /* Disconnect entirely from the parent process. If we are running in the
1896 test harness, wait for a bit to allow the previous process time to finish,
1897 write the log, etc., so that the output is always in the same order for
1898 automatic comparison. */
1899
1900 if ((pid = fork()) != 0) _exit(EXIT_SUCCESS);
ed0e9820 1901 if (running_in_test_harness) sleep(1);
059ec3d9
PH
1902
1903 /* Set up the calling arguments; use the standard function for the basics,
1904 but we have a number of extras that may be added. */
1905
55414b25 1906 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
059ec3d9 1907
6c1c3d1d 1908 if (smtp_use_dsn) argv[i++] = US"-MCD";
6c1c3d1d 1909
059ec3d9
PH
1910 if (smtp_authenticated) argv[i++] = US"-MCA";
1911
1912 #ifdef SUPPORT_TLS
1913 if (tls_offered) argv[i++] = US"-MCT";
1914 #endif
1915
1916 if (smtp_use_size) argv[i++] = US"-MCS";
1917 if (smtp_use_pipelining) argv[i++] = US"-MCP";
1918
1919 if (queue_run_pid != (pid_t)0)
1920 {
1921 argv[i++] = US"-MCQ";
1922 argv[i++] = string_sprintf("%d", queue_run_pid);
1923 argv[i++] = string_sprintf("%d", queue_run_pipe);
1924 }
1925
1926 argv[i++] = US"-MC";
55414b25
JH
1927 argv[i++] = US transport_name;
1928 argv[i++] = US hostname;
1929 argv[i++] = US hostaddress;
059ec3d9
PH
1930 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1931 argv[i++] = id;
1932 argv[i++] = NULL;
1933
1934 /* Arrange for the channel to be on stdin. */
1935
1936 if (socket_fd != 0)
1937 {
f1e894f3
PH
1938 (void)dup2(socket_fd, 0);
1939 (void)close(socket_fd);
059ec3d9
PH
1940 }
1941
1942 DEBUG(D_exec) debug_print_argv(argv);
1943 exim_nullstd(); /* Ensure std{out,err} exist */
1944 execv(CS argv[0], (char *const *)argv);
1945
1946 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1947 _exit(errno); /* Note: must be _exit(), NOT exit() */
1948 }
1949
1950/* If the process creation succeeded, wait for the first-level child, which
1951immediately exits, leaving the second level process entirely disconnected from
1952this one. */
1953
1954if (pid > 0)
1955 {
1956 int rc;
1957 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
1958 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded\n");
1959 return TRUE;
1960 }
1961else
1962 {
1963 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
1964 strerror(errno));
1965 return FALSE;
1966 }
1967}
1968
1969
1970
1971/*************************************************
1972* Set up direct (non-shell) command *
1973*************************************************/
1974
1975/* This function is called when a command line is to be parsed and executed
1976directly, without the use of /bin/sh. It is called by the pipe transport,
1977the queryprogram router, and also from the main delivery code when setting up a
1978transport filter process. The code for ETRN also makes use of this; in that
1979case, no addresses are passed.
1980
1981Arguments:
1982 argvptr pointer to anchor for argv vector
55414b25 1983 cmd points to the command string (modified IN PLACE)
059ec3d9
PH
1984 expand_arguments true if expansion is to occur
1985 expand_failed error value to set if expansion fails; not relevant if
1986 addr == NULL
1987 addr chain of addresses, or NULL
1988 etext text for use in error messages
1989 errptr where to put error message if addr is NULL;
1990 otherwise it is put in the first address
1991
1992Returns: TRUE if all went well; otherwise an error will be
1993 set in the first address and FALSE returned
1994*/
1995
1996BOOL
55414b25
JH
1997transport_set_up_command(const uschar ***argvptr, uschar *cmd,
1998 BOOL expand_arguments, int expand_failed, address_item *addr,
1999 uschar *etext, uschar **errptr)
059ec3d9
PH
2000{
2001address_item *ad;
55414b25 2002const uschar **argv;
059ec3d9
PH
2003uschar *s, *ss;
2004int address_count = 0;
2005int argcount = 0;
2006int i, max_args;
2007
2008/* Get store in which to build an argument list. Count the number of addresses
2009supplied, and allow for that many arguments, plus an additional 60, which
2010should be enough for anybody. Multiple addresses happen only when the local
2011delivery batch option is set. */
2012
2013for (ad = addr; ad != NULL; ad = ad->next) address_count++;
2014max_args = address_count + 60;
2015*argvptr = argv = store_get((max_args+1)*sizeof(uschar *));
2016
2017/* Split the command up into arguments terminated by white space. Lose
2018trailing space at the start and end. Double-quoted arguments can contain \\ and
2019\" escapes and so can be handled by the standard function; single-quoted
2020arguments are verbatim. Copy each argument into a new string. */
2021
2022s = cmd;
2023while (isspace(*s)) s++;
2024
2025while (*s != 0 && argcount < max_args)
2026 {
2027 if (*s == '\'')
2028 {
2029 ss = s + 1;
2030 while (*ss != 0 && *ss != '\'') ss++;
2031 argv[argcount++] = ss = store_get(ss - s++);
2032 while (*s != 0 && *s != '\'') *ss++ = *s++;
2033 if (*s != 0) s++;
2034 *ss++ = 0;
2035 }
55414b25 2036 else argv[argcount++] = string_copy(string_dequote(CUSS &s));
059ec3d9
PH
2037 while (isspace(*s)) s++;
2038 }
2039
2040argv[argcount] = (uschar *)0;
2041
2042/* If *s != 0 we have run out of argument slots. */
2043
2044if (*s != 0)
2045 {
2046 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2047 "%s", cmd, etext);
2048 if (addr != NULL)
2049 {
2050 addr->transport_return = FAIL;
2051 addr->message = msg;
2052 }
2053 else *errptr = msg;
2054 return FALSE;
2055 }
2056
2057/* Expand each individual argument if required. Expansion happens for pipes set
2058up in filter files and with directly-supplied commands. It does not happen if
2059the pipe comes from a traditional .forward file. A failing expansion is a big
2060disaster if the command came from Exim's configuration; if it came from a user
2061it is just a normal failure. The expand_failed value is used as the error value
2062to cater for these two cases.
2063
2064An argument consisting just of the text "$pipe_addresses" is treated specially.
2065It is not passed to the general expansion function. Instead, it is replaced by
2066a number of arguments, one for each address. This avoids problems with shell
2067metacharacters and spaces in addresses.
2068
2069If the parent of the top address has an original part of "system-filter", this
2070pipe was set up by the system filter, and we can permit the expansion of
2071$recipients. */
2072
2073DEBUG(D_transport)
2074 {
2075 debug_printf("direct command:\n");
2076 for (i = 0; argv[i] != (uschar *)0; i++)
2077 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2078 }
2079
2080if (expand_arguments)
2081 {
2082 BOOL allow_dollar_recipients = addr != NULL &&
2083 addr->parent != NULL &&
2084 Ustrcmp(addr->parent->address, "system-filter") == 0;
2085
2086 for (i = 0; argv[i] != (uschar *)0; i++)
2087 {
2088
2089 /* Handle special fudge for passing an address list */
2090
2091 if (addr != NULL &&
2092 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2093 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2094 {
2095 int additional;
2096
2097 if (argcount + address_count - 1 > max_args)
2098 {
2099 addr->transport_return = FAIL;
2100 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2101 "in %s", cmd, etext);
2102 return FALSE;
2103 }
2104
2105 additional = address_count - 1;
2106 if (additional > 0)
2107 memmove(argv + i + 1 + additional, argv + i + 1,
2108 (argcount - i)*sizeof(uschar *));
2109
09792322
NK
2110 for (ad = addr; ad != NULL; ad = ad->next) {
2111 argv[i++] = ad->address;
2112 argcount++;
2113 }
2114
700d22f3
PP
2115 /* Subtract one since we replace $pipe_addresses */
2116 argcount--;
2117 i--;
09792322
NK
2118 }
2119
2120 /* Handle special case of $address_pipe when af_force_command is set */
2121
2122 else if (addr != NULL && testflag(addr,af_force_command) &&
2123 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2124 Ustrcmp(argv[i], "${address_pipe}") == 0))
2125 {
2126 int address_pipe_i;
2127 int address_pipe_argcount = 0;
2128 int address_pipe_max_args;
2129 uschar **address_pipe_argv;
2130
2131 /* We can never have more then the argv we will be loading into */
2132 address_pipe_max_args = max_args - argcount + 1;
2133
2134 DEBUG(D_transport)
700d22f3 2135 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
09792322
NK
2136
2137 /* We allocate an additional for (uschar *)0 */
2138 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *));
2139
2140 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2141 s = expand_string(addr->local_part + 1);
2142
700d22f3
PP
2143 if (s == NULL || *s == '\0')
2144 {
2145 addr->transport_return = FAIL;
2146 addr->message = string_sprintf("Expansion of \"%s\" "
2147 "from command \"%s\" in %s failed: %s",
2148 (addr->local_part + 1), cmd, etext, expand_string_message);
09792322 2149 return FALSE;
700d22f3 2150 }
09792322
NK
2151
2152 while (isspace(*s)) s++; /* strip leading space */
2153
2154 while (*s != 0 && address_pipe_argcount < address_pipe_max_args)
2155 {
2156 if (*s == '\'')
2157 {
2158 ss = s + 1;
2159 while (*ss != 0 && *ss != '\'') ss++;
2160 address_pipe_argv[address_pipe_argcount++] = ss = store_get(ss - s++);
2161 while (*s != 0 && *s != '\'') *ss++ = *s++;
2162 if (*s != 0) s++;
2163 *ss++ = 0;
2164 }
55414b25
JH
2165 else address_pipe_argv[address_pipe_argcount++] =
2166 string_copy(string_dequote(CUSS &s));
09792322
NK
2167 while (isspace(*s)) s++; /* strip space after arg */
2168 }
2169
2170 address_pipe_argv[address_pipe_argcount] = (uschar *)0;
2171
2172 /* If *s != 0 we have run out of argument slots. */
2173 if (*s != 0)
2174 {
2175 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2176 "\"%s\" in %s", addr->local_part + 1, etext);
2177 if (addr != NULL)
2178 {
2179 addr->transport_return = FAIL;
2180 addr->message = msg;
2181 }
2182 else *errptr = msg;
2183 return FALSE;
2184 }
2185
700d22f3
PP
2186 /* address_pipe_argcount - 1
2187 * because we are replacing $address_pipe in the argument list
2188 * with the first thing it expands to */
09792322
NK
2189 if (argcount + address_pipe_argcount - 1 > max_args)
2190 {
2191 addr->transport_return = FAIL;
2192 addr->message = string_sprintf("Too many arguments to command "
2193 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2194 return FALSE;
2195 }
2196
2197 /* If we are not just able to replace the slot that contained
2198 * $address_pipe (address_pipe_argcount == 1)
700d22f3 2199 * We have to move the existing argv by address_pipe_argcount - 1
09792322
NK
2200 * Visually if address_pipe_argcount == 2:
2201 * [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
700d22f3 2202 * [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0]
09792322
NK
2203 */
2204 if (address_pipe_argcount > 1)
2205 memmove(
2206 /* current position + additonal args */
2207 argv + i + address_pipe_argcount,
2208 /* current position + 1 (for the (uschar *)0 at the end) */
2209 argv + i + 1,
2210 /* -1 for the (uschar *)0 at the end)*/
2211 (argcount - i)*sizeof(uschar *)
2212 );
2213
2214 /* Now we fill in the slots we just moved argv out of
2215 * [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0]
2216 */
700d22f3
PP
2217 for (address_pipe_i = 0;
2218 address_pipe_argv[address_pipe_i] != (uschar *)0;
2219 address_pipe_i++)
2220 {
2221 argv[i++] = address_pipe_argv[address_pipe_i];
2222 argcount++;
09792322
NK
2223 }
2224
700d22f3
PP
2225 /* Subtract one since we replace $address_pipe */
2226 argcount--;
2227 i--;
059ec3d9
PH
2228 }
2229
2230 /* Handle normal expansion string */
2231
2232 else
2233 {
55414b25 2234 const uschar *expanded_arg;
059ec3d9 2235 enable_dollar_recipients = allow_dollar_recipients;
55414b25 2236 expanded_arg = expand_cstring(argv[i]);
059ec3d9
PH
2237 enable_dollar_recipients = FALSE;
2238
2239 if (expanded_arg == NULL)
2240 {
2241 uschar *msg = string_sprintf("Expansion of \"%s\" "
2242 "from command \"%s\" in %s failed: %s",
2243 argv[i], cmd, etext, expand_string_message);
2244 if (addr != NULL)
2245 {
2246 addr->transport_return = expand_failed;
2247 addr->message = msg;
2248 }
2249 else *errptr = msg;
2250 return FALSE;
2251 }
2252 argv[i] = expanded_arg;
2253 }
2254 }
2255
2256 DEBUG(D_transport)
2257 {
2258 debug_printf("direct command after expansion:\n");
2259 for (i = 0; argv[i] != (uschar *)0; i++)
2260 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2261 }
2262 }
2263
2264return TRUE;
2265}
2266
511a6c14
JH
2267/* vi: aw ai sw=2
2268*/
059ec3d9 2269/* End of transport.c */