1 /* $Cambridge: exim/src/src/transport.c,v 1.5 2005/03/08 15:32:02 tom Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2005 */
8 /* See the file NOTICE for conditions of use and distribution. */
10 /* General functions concerned with transportation, and generic options for all
17 /* Structure for keeping list of addresses that have been added to
18 Envelope-To:, in order to avoid duplication. */
26 /* Static data for write_chunk() */
28 static uschar *chunk_ptr; /* chunk pointer */
29 static uschar *nl_check; /* string to look for at line start */
30 static int nl_check_length; /* length of same */
31 static uschar *nl_escape; /* string to insert */
32 static int nl_escape_length; /* length of same */
33 static int nl_partial_match; /* length matched at chunk end */
36 /* Generic options for transports, all of which live inside transport_instance
37 data blocks and which therefore have the opt_public flag set. Note that there
38 are other options living inside this structure which can be set only from
39 certain transports. */
41 optionlist optionlist_transports[] = {
42 { "*expand_group", opt_stringptr|opt_hidden|opt_public,
43 (void *)offsetof(transport_instance, expand_gid) },
44 { "*expand_user", opt_stringptr|opt_hidden|opt_public,
45 (void *)offsetof(transport_instance, expand_uid) },
46 { "*headers_rewrite_flags", opt_int|opt_public|opt_hidden,
47 (void *)offsetof(transport_instance, rewrite_existflags) },
48 { "*headers_rewrite_rules", opt_void|opt_public|opt_hidden,
49 (void *)offsetof(transport_instance, rewrite_rules) },
50 { "*set_group", opt_bool|opt_hidden|opt_public,
51 (void *)offsetof(transport_instance, gid_set) },
52 { "*set_user", opt_bool|opt_hidden|opt_public,
53 (void *)offsetof(transport_instance, uid_set) },
54 { "body_only", opt_bool|opt_public,
55 (void *)offsetof(transport_instance, body_only) },
56 { "current_directory", opt_stringptr|opt_public,
57 (void *)offsetof(transport_instance, current_dir) },
58 { "debug_print", opt_stringptr | opt_public,
59 (void *)offsetof(transport_instance, debug_string) },
60 { "delivery_date_add", opt_bool|opt_public,
61 (void *)(offsetof(transport_instance, delivery_date_add)) },
62 { "disable_logging", opt_bool|opt_public,
63 (void *)(offsetof(transport_instance, disable_logging)) },
64 { "driver", opt_stringptr|opt_public,
65 (void *)offsetof(transport_instance, driver_name) },
66 { "envelope_to_add", opt_bool|opt_public,
67 (void *)(offsetof(transport_instance, envelope_to_add)) },
68 { "group", opt_expand_gid|opt_public,
69 (void *)offsetof(transport_instance, gid) },
70 { "headers_add", opt_stringptr|opt_public,
71 (void *)offsetof(transport_instance, add_headers) },
72 { "headers_only", opt_bool|opt_public,
73 (void *)offsetof(transport_instance, headers_only) },
74 { "headers_remove", opt_stringptr|opt_public,
75 (void *)offsetof(transport_instance, remove_headers) },
76 { "headers_rewrite", opt_rewrite|opt_public,
77 (void *)offsetof(transport_instance, headers_rewrite) },
78 { "home_directory", opt_stringptr|opt_public,
79 (void *)offsetof(transport_instance, home_dir) },
80 { "initgroups", opt_bool|opt_public,
81 (void *)offsetof(transport_instance, initgroups) },
82 { "message_size_limit", opt_stringptr|opt_public,
83 (void *)offsetof(transport_instance, message_size_limit) },
84 { "rcpt_include_affixes", opt_bool|opt_public,
85 (void *)offsetof(transport_instance, rcpt_include_affixes) },
86 { "retry_use_local_part", opt_bool|opt_public,
87 (void *)offsetof(transport_instance, retry_use_local_part) },
88 { "return_path", opt_stringptr|opt_public,
89 (void *)(offsetof(transport_instance, return_path)) },
90 { "return_path_add", opt_bool|opt_public,
91 (void *)(offsetof(transport_instance, return_path_add)) },
92 { "shadow_condition", opt_stringptr|opt_public,
93 (void *)offsetof(transport_instance, shadow_condition) },
94 { "shadow_transport", opt_stringptr|opt_public,
95 (void *)offsetof(transport_instance, shadow) },
96 { "transport_filter", opt_stringptr|opt_public,
97 (void *)offsetof(transport_instance, filter_command) },
98 { "transport_filter_timeout", opt_time|opt_public,
99 (void *)offsetof(transport_instance, filter_timeout) },
100 { "user", opt_expand_uid|opt_public,
101 (void *)offsetof(transport_instance, uid) }
104 int optionlist_transports_size =
105 sizeof(optionlist_transports)/sizeof(optionlist);
108 /*************************************************
109 * Initialize transport list *
110 *************************************************/
112 /* Read the transports section of the configuration file, and set up a chain of
113 transport instances according to its contents. Each transport has generic
114 options and may also have its own private options. This function is only ever
115 called when transports == NULL. We use generic code in readconf to do most of
121 transport_instance *t;
123 readconf_driver_init(US"transport",
124 (driver_instance **)(&transports), /* chain anchor */
125 (driver_info *)transports_available, /* available drivers */
126 sizeof(transport_info), /* size of info block */
127 &transport_defaults, /* default values for generic options */
128 sizeof(transport_instance), /* size of instance block */
129 optionlist_transports, /* generic options */
130 optionlist_transports_size);
132 /* Now scan the configured transports and check inconsistencies. A shadow
133 transport is permitted only for local transports. */
135 for (t = transports; t != NULL; t = t->next)
139 if (t->shadow != NULL)
140 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
141 "shadow transport not allowed on non-local transport %s", t->name);
144 if (t->body_only && t->headers_only)
145 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
146 "%s transport: body_only and headers_only are mutually exclusive",
153 /*************************************************
154 * Write block of data *
155 *************************************************/
157 /* Subroutine called by write_chunk() and at the end of the message actually
158 to write a data block. Also called directly by some transports to write
159 additional data to the file descriptor (e.g. prefix, suffix).
161 If a transport wants data transfers to be timed, it sets a non-zero value in
162 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
163 be set for each block of data written from here. If time runs out, then write()
164 fails and provokes an error return. The caller can then inspect sigalrm_seen to
167 On some systems, if a quota is exceeded during the write, the yield is the
168 number of bytes written rather than an immediate error code. This also happens
169 on some systems in other cases, for example a pipe that goes away because the
170 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
171 get the error codes the first time.
173 The write() function is also interruptible; the Solaris 2.6 man page says:
175 If write() is interrupted by a signal before it writes any
176 data, it will return -1 with errno set to EINTR.
178 If write() is interrupted by a signal after it successfully
179 writes some data, it will return the number of bytes written.
181 To handle these cases, we want to restart the write() to output the remainder
182 of the data after a non-negative return from write(), except after a timeout.
183 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
184 proper error then occurs. In principle, after an interruption, the second
185 write() could suffer the same fate, but we do not want to continue for
186 evermore, so stick a maximum repetition count on the loop to act as a
190 fd file descriptor to write to
191 block block of bytes to write
192 len number of bytes to write
194 Returns: TRUE on success, FALSE on failure (with errno preserved);
195 transport_count is incremented by the number of bytes written
199 transport_write_block(int fd, uschar *block, int len)
201 int i, rc, save_errno;
203 for (i = 0; i < 100; i++)
206 debug_printf("writing data block fd=%d size=%d timeout=%d\n",
207 fd, len, transport_write_timeout);
208 if (transport_write_timeout > 0) alarm(transport_write_timeout);
211 if (tls_active == fd) rc = tls_write(block, len); else
214 rc = write(fd, block, len);
217 /* Cancel the alarm and deal with a timeout */
219 if (transport_write_timeout > 0)
229 /* Hopefully, the most common case is success, so test that first. */
231 if (rc == len) { transport_count += len; return TRUE; }
233 /* A non-negative return code is an incomplete write. Try again. */
239 transport_count += rc;
240 DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
244 /* A negative return code with an EINTR error is another form of
245 incomplete write, zero bytes having been written */
247 if (save_errno == EINTR)
250 debug_printf("write interrupted before anything written\n");
254 /* A response of EAGAIN from write() is likely only in the case of writing
255 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
257 if (save_errno == EAGAIN)
260 debug_printf("write temporarily locked out, waiting 1 sec\n");
265 /* Otherwise there's been an error */
267 DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
268 strerror(save_errno));
273 /* We've tried and tried and tried but still failed */
275 errno = ERRNO_WRITEINCOMPLETE;
282 /*************************************************
283 * Write formatted string *
284 *************************************************/
286 /* This is called by various transports. It is a convenience function.
291 ... arguments for format
293 Returns: the yield of transport_write_block()
297 transport_write_string(int fd, char *format, ...)
300 va_start(ap, format);
301 if (!string_vformat(big_buffer, big_buffer_size, format, ap))
302 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
304 return transport_write_block(fd, big_buffer, Ustrlen(big_buffer));
310 /*************************************************
311 * Write character chunk *
312 *************************************************/
314 /* Subroutine used by transport_write_message() to scan character chunks for
315 newlines and act appropriately. The object is to minimise the number of writes.
316 The output byte stream is buffered up in deliver_out_buffer, which is written
317 only when it gets full, thus minimizing write operations and TCP packets.
319 Static data is used to handle the case when the last character of the previous
320 chunk was NL, or matched part of the data that has to be escaped.
323 fd file descript to write to
324 chunk pointer to data to write
325 len length of data to write
326 usr_crlf TRUE if CR LF is wanted at the end of each line
328 In addition, the static nl_xxx variables must be set as required.
330 Returns: TRUE on success, FALSE on failure (with errno preserved)
334 write_chunk(int fd, uschar *chunk, int len, BOOL use_crlf)
336 uschar *start = chunk;
337 uschar *end = chunk + len;
338 register uschar *ptr;
339 int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
341 /* The assumption is made that the check string will never stretch over move
342 than one chunk since the only time there are partial matches is when copying
343 the body in large buffers. There is always enough room in the buffer for an
344 escape string, since the loop below ensures this for each character it
345 processes, and it won't have stuck in the escape string if it left a partial
348 if (nl_partial_match >= 0)
350 if (nl_check_length > 0 && len >= nl_check_length &&
351 Ustrncmp(start, nl_check + nl_partial_match,
352 nl_check_length - nl_partial_match) == 0)
354 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
355 chunk_ptr += nl_escape_length;
356 start += nl_check_length - nl_partial_match;
359 /* The partial match was a false one. Insert the characters carried over
360 from the previous chunk. */
362 else if (nl_partial_match > 0)
364 Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
365 chunk_ptr += nl_partial_match;
368 nl_partial_match = -1;
371 /* Now process the characters in the chunk. Whenever we hit a newline we check
372 for possible escaping. The code for the non-NL route should be as fast as
375 for (ptr = start; ptr < end; ptr++)
379 /* Flush the buffer if it has reached the threshold - we want to leave enough
380 room for the next uschar, plus a possible extra CR for an LF, plus the escape
383 if (chunk_ptr - deliver_out_buffer > mlen)
385 if (!transport_write_block(fd, deliver_out_buffer,
386 chunk_ptr - deliver_out_buffer))
388 chunk_ptr = deliver_out_buffer;
391 if ((ch = *ptr) == '\n')
393 int left = end - ptr - 1; /* count of chars left after NL */
395 /* Insert CR before NL if required */
397 if (use_crlf) *chunk_ptr++ = '\r';
400 /* The check_string test (formerly "from hack") replaces the specific
401 string at the start of a line with an escape string (e.g. "From " becomes
402 ">From " or "." becomes "..". It is a case-sensitive test. The length
403 check above ensures there is always enough room to insert this string. */
405 if (nl_check_length > 0)
407 if (left >= nl_check_length &&
408 Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
410 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
411 chunk_ptr += nl_escape_length;
412 ptr += nl_check_length;
415 /* Handle the case when there isn't enough left to match the whole
416 check string, but there may be a partial match. We remember how many
417 characters matched, and finish processing this chunk. */
419 else if (left <= 0) nl_partial_match = 0;
421 else if (Ustrncmp(ptr+1, nl_check, left) == 0)
423 nl_partial_match = left;
429 /* Not a NL character */
431 else *chunk_ptr++ = ch;
440 /*************************************************
441 * Generate address for RCPT TO *
442 *************************************************/
444 /* This function puts together an address for RCPT to, using the caseful
445 version of the local part and the caseful version of the domain. If there is no
446 prefix or suffix, or if affixes are to be retained, we can just use the
447 original address. Otherwise, if there is a prefix but no suffix we can use a
448 pointer into the original address. If there is a suffix, however, we have to
452 addr the address item
453 include_affixes TRUE if affixes are to be included
459 transport_rcpt_address(address_item *addr, BOOL include_affixes)
466 setflag(addr, af_include_affixes); /* Affects logged => line */
467 return addr->address;
470 if (addr->suffix == NULL)
472 if (addr->prefix == NULL) return addr->address;
473 return addr->address + Ustrlen(addr->prefix);
476 at = Ustrrchr(addr->address, '@');
477 plen = (addr->prefix == NULL)? 0 : Ustrlen(addr->prefix);
478 slen = Ustrlen(addr->suffix);
480 return string_sprintf("%.*s@%s", (at - addr->address - plen - slen),
481 addr->address + plen, at + 1);
485 /*************************************************
486 * Output Envelope-To: address & scan duplicates *
487 *************************************************/
489 /* This function is called from internal_transport_write_message() below, when
490 generating an Envelope-To: header line. It checks for duplicates of the given
491 address and its ancestors. When one is found, this function calls itself
492 recursively, to output the envelope address of the duplicate.
494 We want to avoid duplication in the list, which can arise for example when
495 A->B,C and then both B and C alias to D. This can also happen when there are
496 unseen drivers in use. So a list of addresses that have been output is kept in
499 It is also possible to have loops in the address ancestry/duplication graph,
500 for example if there are two top level addresses A and B and we have A->B,C and
501 B->A. To break the loop, we use a list of processed addresses in the dlist
504 After handling duplication, this function outputs the progenitor of the given
508 p the address we are interested in
509 pplist address of anchor of the list of addresses not to output
510 pdlist address of anchor of the list of processed addresses
511 first TRUE if this is the first address; set it FALSE afterwards
512 fd the file descriptor to write to
513 use_crlf to be passed on to write_chunk()
515 Returns: FALSE if writing failed
519 write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
520 BOOL *first, int fd, BOOL use_crlf)
525 /* Do nothing if we have already handled this address. If not, remember it
526 so that we don't handle it again. */
528 for (ppp = *pdlist; ppp != NULL; ppp = ppp->next)
529 { if (p == ppp->ptr) return TRUE; }
531 ppp = store_get(sizeof(struct aci));
536 /* Now scan up the ancestry, checking for duplicates at each generation. */
538 for (pp = p;; pp = pp->parent)
541 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
543 if (dup->dupof != pp) continue; /* Not a dup of our address */
544 if (!write_env_to(dup, pplist, pdlist, first, fd, use_crlf)) return FALSE;
546 if (pp->parent == NULL) break;
549 /* Check to see if we have already output the progenitor. */
551 for (ppp = *pplist; ppp != NULL; ppp = ppp->next)
552 { if (pp == ppp->ptr) break; }
553 if (ppp != NULL) return TRUE;
555 /* Remember what we have output, and output it. */
557 ppp = store_get(sizeof(struct aci));
562 if (!(*first) && !write_chunk(fd, US",\n ", 3, use_crlf)) return FALSE;
564 return write_chunk(fd, pp->address, Ustrlen(pp->address), use_crlf);
570 /*************************************************
571 * Write the message *
572 *************************************************/
574 /* This function writes the message to the given file descriptor. The headers
575 are in the in-store data structure, and the rest of the message is in the open
576 file descriptor deliver_datafile. Make sure we start it at the beginning.
578 . If add_return_path is TRUE, a "return-path:" header is added to the message,
579 containing the envelope sender's address.
581 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
582 giving the top-level envelope address that caused this delivery to happen.
584 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
585 message. It gives the time and date that delivery took place.
587 . If check_string is not null, the start of each line is checked for that
588 string. If it is found, it is replaced by escape_string. This used to be
589 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
591 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
593 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
594 any writing or reading error, leaving the code in errno intact. Error exits
595 can include timeouts for certain transports, which are requested by setting
596 transport_write_timeout non-zero.
599 addr (chain of) addresses (for extra headers), or NULL;
600 only the first address is used
601 fd file descriptor to write the message to
602 options bit-wise options:
603 add_return_path if TRUE, add a "return-path" header
604 add_envelope_to if TRUE, add a "envelope-to" header
605 add_delivery_date if TRUE, add a "delivery-date" header
606 use_crlf if TRUE, turn NL into CR LF
607 end_dot if TRUE, send a terminating "." line at the end
608 no_headers if TRUE, omit the headers
609 no_body if TRUE, omit the body
610 size_limit if > 0, this is a limit to the size of message written;
611 it is used when returning messages to their senders,
612 and is approximate rather than exact, owing to chunk
614 add_headers a string containing one or more headers to add; it is
615 expanded, and must be in correct RFC 822 format as
616 it is transmitted verbatim; NULL => no additions,
617 and so does empty string or forced expansion fail
618 remove_headers a colon-separated list of headers to remove, or NULL
619 check_string a string to check for at the start of lines, or NULL
620 escape_string a string to insert in front of any check string
621 rewrite_rules chain of header rewriting rules
622 rewrite_existflags flags for the rewriting rules
624 Returns: TRUE on success; FALSE (with errno) on failure.
625 In addition, the global variable transport_count
626 is incremented by the number of bytes written.
630 internal_transport_write_message(address_item *addr, int fd, int options,
631 int size_limit, uschar *add_headers, uschar *remove_headers, uschar *check_string,
632 uschar *escape_string, rewrite_rule *rewrite_rules, int rewrite_existflags)
637 BOOL use_crlf = (options & topt_use_crlf) != 0;
639 /* Initialize pointer in output buffer. */
641 chunk_ptr = deliver_out_buffer;
643 /* Set up the data for start-of-line data checking and escaping */
645 nl_partial_match = -1;
646 if (check_string != NULL && escape_string != NULL)
648 nl_check = check_string;
649 nl_check_length = Ustrlen(nl_check);
650 nl_escape = escape_string;
651 nl_escape_length = Ustrlen(nl_escape);
653 else nl_check_length = nl_escape_length = 0;
655 /* Whether the escaping mechanism is applied to headers or not is controlled by
656 an option (set for SMTP, not otherwise). Negate the length if not wanted till
657 after the headers. */
659 if ((options & topt_escape_headers) == 0) nl_check_length = -nl_check_length;
661 /* Write the headers if required, including any that have to be added. If there
662 are header rewriting rules, apply them. */
664 if ((options & topt_no_headers) == 0)
666 /* Add return-path: if requested. */
668 if ((options & topt_add_return_path) != 0)
670 uschar buffer[ADDRESS_MAXLENGTH + 20];
671 sprintf(CS buffer, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH,
673 if (!write_chunk(fd, buffer, Ustrlen(buffer), use_crlf)) return FALSE;
676 /* Add envelope-to: if requested */
678 if ((options & topt_add_envelope_to) != 0)
682 struct aci *plist = NULL;
683 struct aci *dlist = NULL;
684 void *reset_point = store_get(0);
686 if (!write_chunk(fd, US"Envelope-to: ", 13, use_crlf)) return FALSE;
688 /* Pick up from all the addresses. The plist and dlist variables are
689 anchors for lists of addresses already handled; they have to be defined at
690 this level becuase write_env_to() calls itself recursively. */
692 for (p = addr; p != NULL; p = p->next)
694 if (!write_env_to(p, &plist, &dlist, &first, fd, use_crlf)) return FALSE;
697 /* Add a final newline and reset the store used for tracking duplicates */
699 if (!write_chunk(fd, US"\n", 1, use_crlf)) return FALSE;
700 store_reset(reset_point);
703 /* Add delivery-date: if requested. */
705 if ((options & topt_add_delivery_date) != 0)
708 sprintf(CS buffer, "Delivery-date: %s\n", tod_stamp(tod_full));
709 if (!write_chunk(fd, buffer, Ustrlen(buffer), use_crlf)) return FALSE;
712 /* Then the message's headers. Don't write any that are flagged as "old";
713 that means they were rewritten, or are a record of envelope rewriting, or
714 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
715 match any entries therein. Then check addr->p.remove_headers too, provided that
718 if (remove_headers != NULL)
720 uschar *s = expand_string(remove_headers);
721 if (s == NULL && !expand_string_forcedfail)
723 errno = ERRNO_CHHEADER_FAIL;
729 for (h = header_list; h != NULL; h = h->next)
735 if (h->type == htype_old) continue;
737 include_header = TRUE;
738 list = remove_headers;
740 for (i = 0; i < 2; i++) /* For remove_headers && addr->p.remove_headers */
744 int sep = ':'; /* This is specified as a colon-separated list */
747 while ((s = string_nextinlist(&list, &sep, buffer, sizeof(buffer)))
750 int len = Ustrlen(s);
751 if (strncmpic(h->text, s, len) != 0) continue;
753 while (*ss == ' ' || *ss == '\t') ss++;
754 if (*ss == ':') break;
756 if (s != NULL) { include_header = FALSE; break; }
758 if (addr != NULL) list = addr->p.remove_headers;
761 /* If this header is to be output, try to rewrite it if there are rewriting
766 if (rewrite_rules != NULL)
768 void *reset_point = store_get(0);
770 rewrite_header(h, NULL, NULL, rewrite_rules, rewrite_existflags,
774 if (!write_chunk(fd, hh->text, hh->slen, use_crlf)) return FALSE;
775 store_reset(reset_point);
776 continue; /* With the next header line */
780 /* Either no rewriting rules, or it didn't get rewritten */
782 if (!write_chunk(fd, h->text, h->slen, use_crlf)) return FALSE;
789 DEBUG(D_transport) debug_printf("removed header line:\n%s---\n",
794 /* Add on any address-specific headers. If there are multiple addresses,
795 they will all have the same headers in order to be batched. The headers
796 are chained in reverse order of adding (so several addresses from the
797 same alias might share some of them) but we want to output them in the
798 opposite order. This is a bit tedious, but there shouldn't be very many
799 of them. We just walk the list twice, reversing the pointers each time,
800 but on the second time, write out the items. */
805 header_line *hprev = addr->p.extra_headers;
807 for (i = 0; i < 2; i++)
809 for (h = hprev, hprev = NULL; h != NULL; h = hnext)
816 if (!write_chunk(fd, h->text, h->slen, use_crlf)) return FALSE;
818 debug_printf("added header line(s):\n%s---\n", h->text);
824 /* If a string containing additional headers exists, expand it and write
825 out the result. This is done last so that if it (deliberately or accidentally)
826 isn't in header format, it won't mess up any other headers. An empty string
827 or a forced expansion failure are noops. */
829 if (add_headers != NULL)
831 uschar *s = expand_string(add_headers);
834 if (!expand_string_forcedfail)
836 errno = ERRNO_CHHEADER_FAIL;
842 int len = Ustrlen(s);
845 if (!write_chunk(fd, s, len, use_crlf)) return FALSE;
846 if (s[len-1] != '\n' && !write_chunk(fd, US"\n", 1, use_crlf))
849 debug_printf("added header line(s):\n%s---\n", s);
854 /* Separate headers from body with a blank line */
856 if (!write_chunk(fd, US"\n", 1, use_crlf)) return FALSE;
859 /* If the body is required, ensure that the data for check strings (formerly
860 the "from hack") is enabled by negating the length if necessary. (It will be
861 negative in cases where it isn't to apply to the headers). Then ensure the body
862 is positioned at the start of its file (following the message id), then write
863 it, applying the size limit if required. */
865 if ((options & topt_no_body) == 0)
867 nl_check_length = abs(nl_check_length);
868 nl_partial_match = 0;
869 lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET);
870 while ((len = read(deliver_datafile, deliver_in_buffer,
871 DELIVER_IN_BUFFER_SIZE)) > 0)
873 if (!write_chunk(fd, deliver_in_buffer, len, use_crlf)) return FALSE;
877 if (written > size_limit)
879 len = 0; /* Pretend EOF */
885 /* Finished with the check string */
887 nl_check_length = nl_escape_length = 0;
889 /* A read error on the body will have left len == -1 and errno set. */
891 if (len != 0) return FALSE;
893 /* If requested, add a terminating "." line (SMTP output). */
895 if ((options & topt_end_dot) != 0 && !write_chunk(fd, US".\n", 2, use_crlf))
899 /* Write out any remaining data in the buffer before returning. */
901 return (len = chunk_ptr - deliver_out_buffer) <= 0 ||
902 transport_write_block(fd, deliver_out_buffer, len);
906 #ifdef EXPERIMENTAL_DOMAINKEYS
908 /**********************************************************************************
909 * External interface to write the message, while signing it with domainkeys *
910 **********************************************************************************/
912 /* This function is a wrapper around transport_write_message(). It is only called
913 from the smtp transport if
914 (1) Domainkeys support is compiled in.
915 (2) The dk_private_key option on the smtp transport is set.
916 The function sets up a replacement fd into a -K file, then calls the normal
917 function. This way, the exact bits that exim would have put "on the wire" will
918 end up in the file (except for TLS encapsulation, which is the very
919 very last thing). When we are done signing the file, send the
920 signed message down the original fd (or TLS fd).
922 Arguments: as for internal_transport_write_message() above, with additional
924 uschar *dk_private_key The private key to use (filename or plain data)
925 uschar *dk_domain Override domain (normally NULL)
926 uschar *dk_selector The selector to use.
927 uschar *dk_canon The canonalization scheme to use, "simple" or "nofws"
928 uschar *dk_headers Colon-separated header list to include in the signing
930 uschar *dk_strict What to do if signing fails: 1/true => throw error
931 0/false => send anyway
933 Returns: TRUE on success; FALSE (with errno) for any failure
937 dk_transport_write_message(address_item *addr, int fd, int options,
938 int size_limit, uschar *add_headers, uschar *remove_headers,
939 uschar *check_string, uschar *escape_string, rewrite_rule *rewrite_rules,
940 int rewrite_existflags, uschar *dk_private_key, uschar *dk_domain,
941 uschar *dk_selector, uschar *dk_canon, uschar *dk_headers, uschar *dk_strict)
946 uschar dk_spool_name[256];
950 uschar *dk_signature = NULL;
952 snprintf(CS dk_spool_name, 256, "%s/input/%s/%s-K",
953 spool_directory, message_subdir, message_id);
954 dk_fd = Uopen(dk_spool_name, O_RDWR|O_CREAT|O_EXCL, SPOOL_MODE);
957 /* Can't create spool file. Ugh. */
963 /* Call original function */
964 rc = transport_write_message(addr, dk_fd, options,
965 size_limit, add_headers, remove_headers,
966 check_string, escape_string, rewrite_rules,
969 /* Save error state. We must clean up before returning. */
976 /* Rewind file and feed it to the goats^W DK lib */
977 lseek(dk_fd, 0, SEEK_SET);
978 dk_signature = dk_exim_sign(dk_fd,
984 if (dk_signature != NULL)
986 /* Send the signature first */
987 int siglen = Ustrlen(dk_signature);
991 if (tls_active == fd) wwritten = tls_write(dk_signature, siglen); else
993 wwritten = write(fd,dk_signature,siglen);
996 /* error, bail out */
1002 dk_signature += wwritten;
1005 else if (dk_strict != NULL)
1007 uschar *dk_strict_result = expand_string(dk_strict);
1008 if (dk_strict_result != NULL)
1010 if ( (strcmpic(dk_strict,"1") == 0) ||
1011 (strcmpic(dk_strict,"true") == 0) )
1020 /* Rewind file and send it down the original fd. */
1021 lseek(dk_fd, 0, SEEK_SET);
1023 while((sread = read(dk_fd,sbuf,2048)) > 0)
1026 /* write the chunk */
1029 if (tls_active == fd) wwritten = tls_write(p, sread); else
1031 wwritten = write(fd,p,sread);
1034 /* error, bail out */
1039 if (wwritten < sread)
1041 /* short write, try again */
1057 /* unlink -K file */
1059 Uunlink(dk_spool_name);
1066 /*************************************************
1067 * External interface to write the message *
1068 *************************************************/
1070 /* If there is no filtering required, call the internal function above to do
1071 the real work, passing over all the arguments from this function. Otherwise,
1072 set up a filtering process, fork another process to call the internal function
1073 to write to the filter, and in this process just suck from the filter and write
1074 down the given fd. At the end, tidy up the pipes and the processes.
1076 Arguments: as for internal_transport_write_message() above
1078 Returns: TRUE on success; FALSE (with errno) for any failure
1079 transport_count is incremented by the number of bytes written
1083 transport_write_message(address_item *addr, int fd, int options,
1084 int size_limit, uschar *add_headers, uschar *remove_headers,
1085 uschar *check_string, uschar *escape_string, rewrite_rule *rewrite_rules,
1086 int rewrite_existflags)
1089 BOOL last_filter_was_NL = TRUE;
1090 int rc, len, yield, fd_read, fd_write, save_errno;
1092 pid_t filter_pid, write_pid;
1094 /* If there is no filter command set up, call the internal function that does
1095 the actual work, passing it the incoming fd, and return its result. */
1097 if (transport_filter_argv == NULL)
1098 return internal_transport_write_message(addr, fd, options, size_limit,
1099 add_headers, remove_headers, check_string, escape_string,
1100 rewrite_rules, rewrite_existflags);
1102 /* Otherwise the message must be written to a filter process and read back
1103 before being written to the incoming fd. First set up the special processing to
1104 be done during the copying. */
1106 use_crlf = (options & topt_use_crlf) != 0;
1107 nl_partial_match = -1;
1109 if (check_string != NULL && escape_string != NULL)
1111 nl_check = check_string;
1112 nl_check_length = Ustrlen(nl_check);
1113 nl_escape = escape_string;
1114 nl_escape_length = Ustrlen(nl_escape);
1116 else nl_check_length = nl_escape_length = 0;
1118 /* Start up a subprocess to run the command. Ensure that our main fd will
1119 be closed when the subprocess execs, but remove the flag afterwards.
1120 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1121 process to deliver another message.) We get back stdin/stdout file descriptors.
1122 If the process creation failed, give an error return. */
1128 write_pid = (pid_t)(-1);
1130 fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
1131 filter_pid = child_open(transport_filter_argv, NULL, 077, &fd_write, &fd_read,
1133 fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) & ~FD_CLOEXEC);
1134 if (filter_pid < 0) goto TIDY_UP; /* errno set */
1137 debug_printf("process %d running as transport filter: write=%d read=%d\n",
1138 (int)filter_pid, fd_write, fd_read);
1140 /* Fork subprocess to write the message to the filter, and return the result
1141 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1142 smtp dots, or check string processing. */
1144 if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1145 if ((write_pid = fork()) == 0)
1149 close(pfd[pipe_read]);
1150 nl_check_length = nl_escape_length = 0;
1151 rc = internal_transport_write_message(addr, fd_write,
1152 (options & ~(topt_use_crlf | topt_end_dot)),
1153 size_limit, add_headers, remove_headers, NULL, NULL,
1154 rewrite_rules, rewrite_existflags);
1156 write(pfd[pipe_write], (void *)&rc, sizeof(BOOL));
1157 write(pfd[pipe_write], (void *)&save_errno, sizeof(int));
1158 write(pfd[pipe_write], (void *)&(addr->more_errno), sizeof(int));
1163 /* Parent process: close our copy of the writing subprocess' pipes. */
1165 close(pfd[pipe_write]);
1169 /* Writing process creation failed */
1173 errno = save_errno; /* restore */
1177 /* When testing, let the subprocess get going */
1179 if (running_in_test_harness) millisleep(250);
1182 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1184 /* Copy the message from the filter to the output fd. A read error leaves len
1185 == -1 and errno set. We need to apply a timeout to the read, to cope with
1186 the case when the filter gets stuck, but it can be quite a long one. The
1187 default is 5m, but this is now configurable. */
1189 DEBUG(D_transport) debug_printf("copying from the filter\n");
1191 /* Copy the output of the filter, remembering if the last character was NL. If
1192 no data is returned, that counts as "ended with NL" (default setting of the
1193 variable is TRUE). */
1195 chunk_ptr = deliver_out_buffer;
1199 sigalrm_seen = FALSE;
1200 alarm(transport_filter_timeout);
1201 len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1209 /* If the read was successful, write the block down the original fd,
1210 remembering whether it ends in \n or not. */
1214 if (!write_chunk(fd, deliver_in_buffer, len, use_crlf)) goto TIDY_UP;
1215 last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1218 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1222 if (len == 0) yield = TRUE;
1227 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1228 to something. Ensure the pipes are all closed and the processes are removed. If
1229 there has been an error, kill the processes before waiting for them, just to be
1230 sure. Also apply a paranoia timeout. */
1236 if (fd_write > 0) close(fd_write);
1240 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1241 if (write_pid > 0) kill(write_pid, SIGKILL);
1244 /* Wait for the filter process to complete. */
1246 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1247 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1250 save_errno = ERRNO_FILTER_FAIL;
1251 addr->more_errno = rc;
1252 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1255 /* Wait for the writing process to complete. If it ends successfully,
1256 read the results from its pipe, provided we haven't already had a filter
1259 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1262 rc = child_close(write_pid, 30);
1268 read(pfd[pipe_read], (void *)&ok, sizeof(BOOL));
1271 read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1272 read(pfd[pipe_read], (void *)&(addr->more_errno), sizeof(int));
1279 save_errno = ERRNO_FILTER_FAIL;
1280 addr->more_errno = rc;
1281 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1285 close(pfd[pipe_read]);
1287 /* If there have been no problems we can now add the terminating "." if this is
1288 SMTP output, turning off escaping beforehand. If the last character from the
1289 filter was not NL, insert a NL to make the SMTP protocol work. */
1293 nl_check_length = nl_escape_length = 0;
1294 if ((options & topt_end_dot) != 0 && (last_filter_was_NL?
1295 !write_chunk(fd, US".\n", 2, use_crlf) :
1296 !write_chunk(fd, US"\n.\n", 3, use_crlf)))
1301 /* Write out any remaining data in the buffer. */
1305 yield = (len = chunk_ptr - deliver_out_buffer) <= 0 ||
1306 transport_write_block(fd, deliver_out_buffer, len);
1309 else errno = save_errno; /* From some earlier error */
1313 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1315 debug_printf("errno=%d more_errno=%d\n", errno, addr->more_errno);
1325 /*************************************************
1326 * Update waiting database *
1327 *************************************************/
1329 /* This is called when an address is deferred by remote transports that are
1330 capable of sending more than one message over one connection. A database is
1331 maintained for each transport, keeping track of which messages are waiting for
1332 which hosts. The transport can then consult this when eventually a successful
1333 delivery happens, and if it finds that another message is waiting for the same
1334 host, it can fire up a new process to deal with it using the same connection.
1336 The database records are keyed by host name. They can get full if there are
1337 lots of messages waiting, and so there is a continuation mechanism for them.
1339 Each record contains a list of message ids, packed end to end without any
1340 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1341 in this record, and the sequence field says if there are any other records for
1342 this host. If the sequence field is 0, there are none. If it is 1, then another
1343 record with the name <hostname>:0 exists; if it is 2, then two other records
1344 with sequence numbers 0 and 1 exist, and so on.
1346 Currently, an exhaustive search of all continuation records has to be done to
1347 determine whether to add a message id to a given record. This shouldn't be
1348 too bad except in extreme cases. I can't figure out a *simple* way of doing
1351 Old records should eventually get swept up by the exim_tidydb utility.
1354 hostlist list of hosts that this message could be sent to;
1355 the update_waiting flag is set if a host is to be noted
1356 tpname name of the transport
1362 transport_update_waiting(host_item *hostlist, uschar *tpname)
1365 uschar *prevname = US"";
1370 /* Open the database for this transport */
1372 sprintf(CS buffer, "wait-%.200s", tpname);
1373 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1374 if (dbm_file == NULL) return;
1376 /* Scan the list of hosts for which this message is waiting, and ensure
1377 that the message id is in each host record for those that have the
1378 update_waiting flag set. */
1380 for (host = hostlist; host!= NULL; host = host->next)
1382 BOOL already = FALSE;
1383 dbdata_wait *host_record;
1387 /* Skip if the update_waiting flag is not set. */
1389 if (!host->update_waiting) continue;
1391 /* Skip if this is the same host as we just processed; otherwise remember
1392 the name for next time. */
1394 if (Ustrcmp(prevname, host->name) == 0) continue;
1395 prevname = host->name;
1397 /* Look up the host record; if there isn't one, make an empty one. */
1399 host_record = dbfn_read(dbm_file, host->name);
1400 if (host_record == NULL)
1402 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH);
1403 host_record->count = host_record->sequence = 0;
1406 /* Compute the current length */
1408 host_length = host_record->count * MESSAGE_ID_LENGTH;
1410 /* Search the record to see if the current message is already in it. */
1412 for (s = host_record->text; s < host_record->text + host_length;
1413 s += MESSAGE_ID_LENGTH)
1415 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1416 { already = TRUE; break; }
1419 /* If we haven't found this message in the main record, search any
1420 continuation records that exist. */
1422 for (i = host_record->sequence - 1; i >= 0 && !already; i--)
1425 sprintf(CS buffer, "%.200s:%d", host->name, i);
1426 cont = dbfn_read(dbm_file, buffer);
1429 int clen = cont->count * MESSAGE_ID_LENGTH;
1430 for (s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1432 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1433 { already = TRUE; break; }
1438 /* If this message is already in a record, no need to update. */
1440 if (already) continue;
1443 /* If this record is full, write it out with a new name constructed
1444 from the sequence number, increase the sequence number, and empty
1447 if (host_record->count >= WAIT_NAME_MAX)
1449 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1450 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1451 host_record->sequence++;
1452 host_record->count = 0;
1456 /* If this record is not full, increase the size of the record to
1457 allow for one new message id. */
1462 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH);
1463 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1467 /* Now add the new name on the end */
1469 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1470 host_record->count++;
1471 host_length += MESSAGE_ID_LENGTH;
1473 /* Update the database */
1475 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1480 dbfn_close(dbm_file);
1486 /*************************************************
1487 * Test for waiting messages *
1488 *************************************************/
1490 /* This function is called by a remote transport which uses the previous
1491 function to remember which messages are waiting for which remote hosts. It's
1492 called after a successful delivery and its job is to check whether there is
1493 another message waiting for the same host. However, it doesn't do this if the
1494 current continue sequence is greater than the maximum supplied as an argument,
1495 or greater than the global connection_max_messages, which, if set, overrides.
1498 transport_name name of the transport
1499 hostname name of the host
1500 local_message_max maximum number of messages down one connection
1501 as set by the caller transport
1502 new_message_id set to the message id of a waiting message
1503 more set TRUE if there are yet more messages waiting
1505 Returns: TRUE if new_message_id set; FALSE otherwise
1509 transport_check_waiting(uschar *transport_name, uschar *hostname,
1510 int local_message_max, uschar *new_message_id, BOOL *more)
1512 dbdata_wait *host_record;
1513 int host_length, path_len;
1522 debug_printf("transport_check_waiting entered\n");
1523 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1524 continue_sequence, local_message_max, connection_max_messages);
1527 /* Do nothing if we have hit the maximum number that can be send down one
1530 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1531 if (local_message_max > 0 && continue_sequence >= local_message_max)
1534 debug_printf("max messages for one connection reached: returning\n");
1538 /* Open the waiting information database. */
1540 sprintf(CS buffer, "wait-%.200s", transport_name);
1541 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1542 if (dbm_file == NULL) return FALSE;
1544 /* See if there is a record for this host; if not, there's nothing to do. */
1546 host_record = dbfn_read(dbm_file, hostname);
1547 if (host_record == NULL)
1549 dbfn_close(dbm_file);
1550 DEBUG(D_transport) debug_printf("no messages waiting for %s\n", hostname);
1554 /* If the data in the record looks corrupt, just log something and
1555 don't try to use it. */
1557 if (host_record->count > WAIT_NAME_MAX)
1559 dbfn_close(dbm_file);
1560 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1561 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1565 /* Scan the message ids in the record from the end towards the beginning,
1566 until one is found for which a spool file actually exists. If the record gets
1567 emptied, delete it and continue with any continuation records that may exist.
1570 host_length = host_record->count * MESSAGE_ID_LENGTH;
1572 /* Loop to handle continuation host records in the database */
1578 sprintf(CS buffer, "%s/input/", spool_directory);
1579 path_len = Ustrlen(buffer);
1581 for (host_length -= MESSAGE_ID_LENGTH; host_length >= 0;
1582 host_length -= MESSAGE_ID_LENGTH)
1584 struct stat statbuf;
1585 Ustrncpy(new_message_id, host_record->text + host_length,
1587 new_message_id[MESSAGE_ID_LENGTH] = 0;
1589 if (split_spool_directory)
1590 sprintf(CS(buffer + path_len), "%c/%s-D", new_message_id[5], new_message_id);
1592 sprintf(CS(buffer + path_len), "%s-D", new_message_id);
1594 /* The listed message may be the one we are currently processing. If
1595 so, we want to remove it from the list without doing anything else.
1596 If not, do a stat to see if it is an existing message. If it is, break
1597 the loop to handle it. No need to bother about locks; as this is all
1598 "hint" processing, it won't matter if it doesn't exist by the time exim
1599 actually tries to deliver it. */
1601 if (Ustrcmp(new_message_id, message_id) != 0 &&
1602 Ustat(buffer, &statbuf) == 0)
1609 /* If we have removed all the message ids from the record delete the record.
1610 If there is a continuation record, fetch it and remove it from the file,
1611 as it will be rewritten as the main record. Repeat in the case of an
1612 empty continuation. */
1614 while (host_length <= 0)
1617 dbdata_wait *newr = NULL;
1619 /* Search for a continuation */
1621 for (i = host_record->sequence - 1; i >= 0 && newr == NULL; i--)
1623 sprintf(CS buffer, "%.200s:%d", hostname, i);
1624 newr = dbfn_read(dbm_file, buffer);
1627 /* If no continuation, delete the current and break the loop */
1631 dbfn_delete(dbm_file, hostname);
1635 /* Else replace the current with the continuation */
1637 dbfn_delete(dbm_file, buffer);
1639 host_length = host_record->count * MESSAGE_ID_LENGTH;
1642 /* If we found an existing message, break the continuation loop. */
1646 /* If host_length <= 0 we have emptied a record and not found a good message,
1647 and there are no continuation records. Otherwise there is a continuation
1648 record to process. */
1650 if (host_length <= 0)
1652 dbfn_close(dbm_file);
1653 DEBUG(D_transport) debug_printf("waiting messages already delivered\n");
1658 /* Control gets here when an existing message has been encountered; its
1659 id is in new_message_id, and host_length is the revised length of the
1660 host record. If it is zero, the record has been removed. Update the
1661 record if required, close the database, and return TRUE. */
1663 if (host_length > 0)
1665 host_record->count = host_length/MESSAGE_ID_LENGTH;
1666 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1670 dbfn_close(dbm_file);
1676 /*************************************************
1677 * Deliver waiting message down same socket *
1678 *************************************************/
1680 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1681 get a clean delivery process, and to regain root privilege in cases where it
1682 has been given away.
1685 transport_name to pass to the new process
1688 id the new message to process
1689 socket_fd the connected socket
1691 Returns: FALSE if fork fails; TRUE otherwise
1695 transport_pass_socket(uschar *transport_name, uschar *hostname,
1696 uschar *hostaddress, uschar *id, int socket_fd)
1701 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
1703 if ((pid = fork()) == 0)
1708 /* Disconnect entirely from the parent process. If we are running in the
1709 test harness, wait for a bit to allow the previous process time to finish,
1710 write the log, etc., so that the output is always in the same order for
1711 automatic comparison. */
1713 if ((pid = fork()) != 0) _exit(EXIT_SUCCESS);
1714 if (running_in_test_harness) millisleep(500);
1716 /* Set up the calling arguments; use the standard function for the basics,
1717 but we have a number of extras that may be added. */
1719 argv = child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1721 if (smtp_authenticated) argv[i++] = US"-MCA";
1724 if (tls_offered) argv[i++] = US"-MCT";
1727 if (smtp_use_size) argv[i++] = US"-MCS";
1728 if (smtp_use_pipelining) argv[i++] = US"-MCP";
1730 if (queue_run_pid != (pid_t)0)
1732 argv[i++] = US"-MCQ";
1733 argv[i++] = string_sprintf("%d", queue_run_pid);
1734 argv[i++] = string_sprintf("%d", queue_run_pipe);
1737 argv[i++] = US"-MC";
1738 argv[i++] = transport_name;
1739 argv[i++] = hostname;
1740 argv[i++] = hostaddress;
1741 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1745 /* Arrange for the channel to be on stdin. */
1753 DEBUG(D_exec) debug_print_argv(argv);
1754 exim_nullstd(); /* Ensure std{out,err} exist */
1755 execv(CS argv[0], (char *const *)argv);
1757 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1758 _exit(errno); /* Note: must be _exit(), NOT exit() */
1761 /* If the process creation succeeded, wait for the first-level child, which
1762 immediately exits, leaving the second level process entirely disconnected from
1768 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
1769 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded\n");
1774 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
1782 /*************************************************
1783 * Set up direct (non-shell) command *
1784 *************************************************/
1786 /* This function is called when a command line is to be parsed and executed
1787 directly, without the use of /bin/sh. It is called by the pipe transport,
1788 the queryprogram router, and also from the main delivery code when setting up a
1789 transport filter process. The code for ETRN also makes use of this; in that
1790 case, no addresses are passed.
1793 argvptr pointer to anchor for argv vector
1794 cmd points to the command string
1795 expand_arguments true if expansion is to occur
1796 expand_failed error value to set if expansion fails; not relevant if
1798 addr chain of addresses, or NULL
1799 etext text for use in error messages
1800 errptr where to put error message if addr is NULL;
1801 otherwise it is put in the first address
1803 Returns: TRUE if all went well; otherwise an error will be
1804 set in the first address and FALSE returned
1808 transport_set_up_command(uschar ***argvptr, uschar *cmd, BOOL expand_arguments,
1809 int expand_failed, address_item *addr, uschar *etext, uschar **errptr)
1814 int address_count = 0;
1818 /* Get store in which to build an argument list. Count the number of addresses
1819 supplied, and allow for that many arguments, plus an additional 60, which
1820 should be enough for anybody. Multiple addresses happen only when the local
1821 delivery batch option is set. */
1823 for (ad = addr; ad != NULL; ad = ad->next) address_count++;
1824 max_args = address_count + 60;
1825 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *));
1827 /* Split the command up into arguments terminated by white space. Lose
1828 trailing space at the start and end. Double-quoted arguments can contain \\ and
1829 \" escapes and so can be handled by the standard function; single-quoted
1830 arguments are verbatim. Copy each argument into a new string. */
1833 while (isspace(*s)) s++;
1835 while (*s != 0 && argcount < max_args)
1840 while (*ss != 0 && *ss != '\'') ss++;
1841 argv[argcount++] = ss = store_get(ss - s++);
1842 while (*s != 0 && *s != '\'') *ss++ = *s++;
1846 else argv[argcount++] = string_dequote(&s);
1847 while (isspace(*s)) s++;
1850 argv[argcount] = (uschar *)0;
1852 /* If *s != 0 we have run out of argument slots. */
1856 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
1860 addr->transport_return = FAIL;
1861 addr->message = msg;
1867 /* Expand each individual argument if required. Expansion happens for pipes set
1868 up in filter files and with directly-supplied commands. It does not happen if
1869 the pipe comes from a traditional .forward file. A failing expansion is a big
1870 disaster if the command came from Exim's configuration; if it came from a user
1871 it is just a normal failure. The expand_failed value is used as the error value
1872 to cater for these two cases.
1874 An argument consisting just of the text "$pipe_addresses" is treated specially.
1875 It is not passed to the general expansion function. Instead, it is replaced by
1876 a number of arguments, one for each address. This avoids problems with shell
1877 metacharacters and spaces in addresses.
1879 If the parent of the top address has an original part of "system-filter", this
1880 pipe was set up by the system filter, and we can permit the expansion of
1885 debug_printf("direct command:\n");
1886 for (i = 0; argv[i] != (uschar *)0; i++)
1887 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
1890 if (expand_arguments)
1892 BOOL allow_dollar_recipients = addr != NULL &&
1893 addr->parent != NULL &&
1894 Ustrcmp(addr->parent->address, "system-filter") == 0;
1896 for (i = 0; argv[i] != (uschar *)0; i++)
1899 /* Handle special fudge for passing an address list */
1902 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
1903 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
1907 if (argcount + address_count - 1 > max_args)
1909 addr->transport_return = FAIL;
1910 addr->message = string_sprintf("Too many arguments to command \"%s\" "
1911 "in %s", cmd, etext);
1915 additional = address_count - 1;
1917 memmove(argv + i + 1 + additional, argv + i + 1,
1918 (argcount - i)*sizeof(uschar *));
1920 for (ad = addr; ad != NULL; ad = ad->next) argv[i++] = ad->address;
1924 /* Handle normal expansion string */
1928 uschar *expanded_arg;
1929 enable_dollar_recipients = allow_dollar_recipients;
1930 expanded_arg = expand_string(argv[i]);
1931 enable_dollar_recipients = FALSE;
1933 if (expanded_arg == NULL)
1935 uschar *msg = string_sprintf("Expansion of \"%s\" "
1936 "from command \"%s\" in %s failed: %s",
1937 argv[i], cmd, etext, expand_string_message);
1940 addr->transport_return = expand_failed;
1941 addr->message = msg;
1946 argv[i] = expanded_arg;
1952 debug_printf("direct command after expansion:\n");
1953 for (i = 0; argv[i] != (uschar *)0; i++)
1954 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
1961 /* End of transport.c */