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