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