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