1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* General functions concerned with transportation, and generic options for all
14 #ifdef HAVE_LINUX_SENDFILE
15 #include <sys/sendfile.h>
18 /* Structure for keeping list of addresses that have been added to
19 Envelope-To:, in order to avoid duplication. */
27 /* Static data for write_chunk() */
29 static uschar *chunk_ptr; /* chunk pointer */
30 static uschar *nl_check; /* string to look for at line start */
31 static int nl_check_length; /* length of same */
32 static uschar *nl_escape; /* string to insert */
33 static int nl_escape_length; /* length of same */
34 static int nl_partial_match; /* length matched at chunk end */
37 /* Generic options for transports, all of which live inside transport_instance
38 data blocks and which therefore have the opt_public flag set. Note that there
39 are other options living inside this structure which can be set only from
40 certain transports. */
42 optionlist optionlist_transports[] = {
43 { "*expand_group", opt_stringptr|opt_hidden|opt_public,
44 (void *)offsetof(transport_instance, expand_gid) },
45 { "*expand_user", opt_stringptr|opt_hidden|opt_public,
46 (void *)offsetof(transport_instance, expand_uid) },
47 { "*headers_rewrite_flags", opt_int|opt_public|opt_hidden,
48 (void *)offsetof(transport_instance, rewrite_existflags) },
49 { "*headers_rewrite_rules", opt_void|opt_public|opt_hidden,
50 (void *)offsetof(transport_instance, rewrite_rules) },
51 { "*set_group", opt_bool|opt_hidden|opt_public,
52 (void *)offsetof(transport_instance, gid_set) },
53 { "*set_user", opt_bool|opt_hidden|opt_public,
54 (void *)offsetof(transport_instance, uid_set) },
55 { "body_only", opt_bool|opt_public,
56 (void *)offsetof(transport_instance, body_only) },
57 { "current_directory", opt_stringptr|opt_public,
58 (void *)offsetof(transport_instance, current_dir) },
59 { "debug_print", opt_stringptr | opt_public,
60 (void *)offsetof(transport_instance, debug_string) },
61 { "delivery_date_add", opt_bool|opt_public,
62 (void *)(offsetof(transport_instance, delivery_date_add)) },
63 { "disable_logging", opt_bool|opt_public,
64 (void *)(offsetof(transport_instance, disable_logging)) },
65 { "driver", opt_stringptr|opt_public,
66 (void *)offsetof(transport_instance, driver_name) },
67 { "envelope_to_add", opt_bool|opt_public,
68 (void *)(offsetof(transport_instance, envelope_to_add)) },
70 { "event_action", opt_stringptr | opt_public,
71 (void *)offsetof(transport_instance, event_action) },
73 { "group", opt_expand_gid|opt_public,
74 (void *)offsetof(transport_instance, gid) },
75 { "headers_add", opt_stringptr|opt_public|opt_rep_str,
76 (void *)offsetof(transport_instance, add_headers) },
77 { "headers_only", opt_bool|opt_public,
78 (void *)offsetof(transport_instance, headers_only) },
79 { "headers_remove", opt_stringptr|opt_public|opt_rep_str,
80 (void *)offsetof(transport_instance, remove_headers) },
81 { "headers_rewrite", opt_rewrite|opt_public,
82 (void *)offsetof(transport_instance, headers_rewrite) },
83 { "home_directory", opt_stringptr|opt_public,
84 (void *)offsetof(transport_instance, home_dir) },
85 { "initgroups", opt_bool|opt_public,
86 (void *)offsetof(transport_instance, initgroups) },
87 { "max_parallel", opt_stringptr|opt_public,
88 (void *)offsetof(transport_instance, max_parallel) },
89 { "message_size_limit", opt_stringptr|opt_public,
90 (void *)offsetof(transport_instance, message_size_limit) },
91 { "rcpt_include_affixes", opt_bool|opt_public,
92 (void *)offsetof(transport_instance, rcpt_include_affixes) },
93 { "retry_use_local_part", opt_bool|opt_public,
94 (void *)offsetof(transport_instance, retry_use_local_part) },
95 { "return_path", opt_stringptr|opt_public,
96 (void *)(offsetof(transport_instance, return_path)) },
97 { "return_path_add", opt_bool|opt_public,
98 (void *)(offsetof(transport_instance, return_path_add)) },
99 { "shadow_condition", opt_stringptr|opt_public,
100 (void *)offsetof(transport_instance, shadow_condition) },
101 { "shadow_transport", opt_stringptr|opt_public,
102 (void *)offsetof(transport_instance, shadow) },
103 { "transport_filter", opt_stringptr|opt_public,
104 (void *)offsetof(transport_instance, filter_command) },
105 { "transport_filter_timeout", opt_time|opt_public,
106 (void *)offsetof(transport_instance, filter_timeout) },
107 { "user", opt_expand_uid|opt_public,
108 (void *)offsetof(transport_instance, uid) }
111 int optionlist_transports_size =
112 sizeof(optionlist_transports)/sizeof(optionlist);
115 /*************************************************
116 * Initialize transport list *
117 *************************************************/
119 /* Read the transports section of the configuration file, and set up a chain of
120 transport instances according to its contents. Each transport has generic
121 options and may also have its own private options. This function is only ever
122 called when transports == NULL. We use generic code in readconf to do most of
128 transport_instance *t;
130 readconf_driver_init(US"transport",
131 (driver_instance **)(&transports), /* chain anchor */
132 (driver_info *)transports_available, /* available drivers */
133 sizeof(transport_info), /* size of info block */
134 &transport_defaults, /* default values for generic options */
135 sizeof(transport_instance), /* size of instance block */
136 optionlist_transports, /* generic options */
137 optionlist_transports_size);
139 /* Now scan the configured transports and check inconsistencies. A shadow
140 transport is permitted only for local transports. */
142 for (t = transports; t != NULL; t = t->next)
146 if (t->shadow != NULL)
147 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
148 "shadow transport not allowed on non-local transport %s", t->name);
151 if (t->body_only && t->headers_only)
152 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
153 "%s transport: body_only and headers_only are mutually exclusive",
160 /*************************************************
161 * Write block of data *
162 *************************************************/
164 /* Subroutine called by write_chunk() and at the end of the message actually
165 to write a data block. Also called directly by some transports to write
166 additional data to the file descriptor (e.g. prefix, suffix).
168 If a transport wants data transfers to be timed, it sets a non-zero value in
169 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
170 be set for each block of data written from here. If time runs out, then write()
171 fails and provokes an error return. The caller can then inspect sigalrm_seen to
174 On some systems, if a quota is exceeded during the write, the yield is the
175 number of bytes written rather than an immediate error code. This also happens
176 on some systems in other cases, for example a pipe that goes away because the
177 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
178 get the error codes the first time.
180 The write() function is also interruptible; the Solaris 2.6 man page says:
182 If write() is interrupted by a signal before it writes any
183 data, it will return -1 with errno set to EINTR.
185 If write() is interrupted by a signal after it successfully
186 writes some data, it will return the number of bytes written.
188 To handle these cases, we want to restart the write() to output the remainder
189 of the data after a non-negative return from write(), except after a timeout.
190 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
191 proper error then occurs. In principle, after an interruption, the second
192 write() could suffer the same fate, but we do not want to continue for
193 evermore, so stick a maximum repetition count on the loop to act as a
197 fd file descriptor to write to
198 block block of bytes to write
199 len number of bytes to write
201 Returns: TRUE on success, FALSE on failure (with errno preserved);
202 transport_count is incremented by the number of bytes written
206 transport_write_block(int fd, uschar *block, int len)
208 int i, rc, save_errno;
209 int local_timeout = transport_write_timeout;
211 /* This loop is for handling incomplete writes and other retries. In most
212 normal cases, it is only ever executed once. */
214 for (i = 0; i < 100; i++)
217 debug_printf("writing data block fd=%d size=%d timeout=%d\n",
218 fd, len, local_timeout);
220 /* This code makes use of alarm() in order to implement the timeout. This
221 isn't a very tidy way of doing things. Using non-blocking I/O with select()
222 provides a neater approach. However, I don't know how to do this when TLS is
225 if (transport_write_timeout <= 0) /* No timeout wanted */
228 if (tls_out.active == fd) rc = tls_write(FALSE, block, len); else
230 rc = write(fd, block, len);
234 /* Timeout wanted. */
238 alarm(local_timeout);
240 if (tls_out.active == fd) rc = tls_write(FALSE, block, len); else
242 rc = write(fd, block, len);
244 local_timeout = alarm(0);
252 /* Hopefully, the most common case is success, so test that first. */
254 if (rc == len) { transport_count += len; return TRUE; }
256 /* A non-negative return code is an incomplete write. Try again for the rest
257 of the block. If we have exactly hit the timeout, give up. */
263 transport_count += rc;
264 DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
265 goto CHECK_TIMEOUT; /* A few lines below */
268 /* A negative return code with an EINTR error is another form of
269 incomplete write, zero bytes having been written */
271 if (save_errno == EINTR)
274 debug_printf("write interrupted before anything written\n");
275 goto CHECK_TIMEOUT; /* A few lines below */
278 /* A response of EAGAIN from write() is likely only in the case of writing
279 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
281 if (save_errno == EAGAIN)
284 debug_printf("write temporarily locked out, waiting 1 sec\n");
287 /* Before continuing to try another write, check that we haven't run out of
291 if (transport_write_timeout > 0 && local_timeout <= 0)
299 /* Otherwise there's been an error */
301 DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
302 strerror(save_errno));
307 /* We've tried and tried and tried but still failed */
309 errno = ERRNO_WRITEINCOMPLETE;
316 /*************************************************
317 * Write formatted string *
318 *************************************************/
320 /* This is called by various transports. It is a convenience function.
325 ... arguments for format
327 Returns: the yield of transport_write_block()
331 transport_write_string(int fd, const char *format, ...)
334 va_start(ap, format);
335 if (!string_vformat(big_buffer, big_buffer_size, format, ap))
336 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
338 return transport_write_block(fd, big_buffer, Ustrlen(big_buffer));
344 /*************************************************
345 * Write character chunk *
346 *************************************************/
348 /* Subroutine used by transport_write_message() to scan character chunks for
349 newlines and act appropriately. The object is to minimise the number of writes.
350 The output byte stream is buffered up in deliver_out_buffer, which is written
351 only when it gets full, thus minimizing write operations and TCP packets.
353 Static data is used to handle the case when the last character of the previous
354 chunk was NL, or matched part of the data that has to be escaped.
357 fd file descript to write to
358 chunk pointer to data to write
359 len length of data to write
360 usr_crlf TRUE if CR LF is wanted at the end of each line
362 In addition, the static nl_xxx variables must be set as required.
364 Returns: TRUE on success, FALSE on failure (with errno preserved)
368 write_chunk(int fd, uschar *chunk, int len, BOOL use_crlf)
370 uschar *start = chunk;
371 uschar *end = chunk + len;
373 int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
375 /* The assumption is made that the check string will never stretch over move
376 than one chunk since the only time there are partial matches is when copying
377 the body in large buffers. There is always enough room in the buffer for an
378 escape string, since the loop below ensures this for each character it
379 processes, and it won't have stuck in the escape string if it left a partial
382 if (nl_partial_match >= 0)
384 if (nl_check_length > 0 && len >= nl_check_length &&
385 Ustrncmp(start, nl_check + nl_partial_match,
386 nl_check_length - nl_partial_match) == 0)
388 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
389 chunk_ptr += nl_escape_length;
390 start += nl_check_length - nl_partial_match;
393 /* The partial match was a false one. Insert the characters carried over
394 from the previous chunk. */
396 else if (nl_partial_match > 0)
398 Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
399 chunk_ptr += nl_partial_match;
402 nl_partial_match = -1;
405 /* Now process the characters in the chunk. Whenever we hit a newline we check
406 for possible escaping. The code for the non-NL route should be as fast as
409 for (ptr = start; ptr < end; ptr++)
413 /* Flush the buffer if it has reached the threshold - we want to leave enough
414 room for the next uschar, plus a possible extra CR for an LF, plus the escape
417 if (chunk_ptr - deliver_out_buffer > mlen)
419 if (!transport_write_block(fd, deliver_out_buffer,
420 chunk_ptr - deliver_out_buffer))
422 chunk_ptr = deliver_out_buffer;
425 if ((ch = *ptr) == '\n')
427 int left = end - ptr - 1; /* count of chars left after NL */
429 /* Insert CR before NL if required */
431 if (use_crlf) *chunk_ptr++ = '\r';
433 transport_newlines++;
435 /* The check_string test (formerly "from hack") replaces the specific
436 string at the start of a line with an escape string (e.g. "From " becomes
437 ">From " or "." becomes "..". It is a case-sensitive test. The length
438 check above ensures there is always enough room to insert this string. */
440 if (nl_check_length > 0)
442 if (left >= nl_check_length &&
443 Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
445 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
446 chunk_ptr += nl_escape_length;
447 ptr += nl_check_length;
450 /* Handle the case when there isn't enough left to match the whole
451 check string, but there may be a partial match. We remember how many
452 characters matched, and finish processing this chunk. */
454 else if (left <= 0) nl_partial_match = 0;
456 else if (Ustrncmp(ptr+1, nl_check, left) == 0)
458 nl_partial_match = left;
464 /* Not a NL character */
466 else *chunk_ptr++ = ch;
475 /*************************************************
476 * Generate address for RCPT TO *
477 *************************************************/
479 /* This function puts together an address for RCPT to, using the caseful
480 version of the local part and the caseful version of the domain. If there is no
481 prefix or suffix, or if affixes are to be retained, we can just use the
482 original address. Otherwise, if there is a prefix but no suffix we can use a
483 pointer into the original address. If there is a suffix, however, we have to
487 addr the address item
488 include_affixes TRUE if affixes are to be included
494 transport_rcpt_address(address_item *addr, BOOL include_affixes)
501 setflag(addr, af_include_affixes); /* Affects logged => line */
502 return addr->address;
505 if (addr->suffix == NULL)
507 if (addr->prefix == NULL) return addr->address;
508 return addr->address + Ustrlen(addr->prefix);
511 at = Ustrrchr(addr->address, '@');
512 plen = (addr->prefix == NULL)? 0 : Ustrlen(addr->prefix);
513 slen = Ustrlen(addr->suffix);
515 return string_sprintf("%.*s@%s", (at - addr->address - plen - slen),
516 addr->address + plen, at + 1);
520 /*************************************************
521 * Output Envelope-To: address & scan duplicates *
522 *************************************************/
524 /* This function is called from internal_transport_write_message() below, when
525 generating an Envelope-To: header line. It checks for duplicates of the given
526 address and its ancestors. When one is found, this function calls itself
527 recursively, to output the envelope address of the duplicate.
529 We want to avoid duplication in the list, which can arise for example when
530 A->B,C and then both B and C alias to D. This can also happen when there are
531 unseen drivers in use. So a list of addresses that have been output is kept in
534 It is also possible to have loops in the address ancestry/duplication graph,
535 for example if there are two top level addresses A and B and we have A->B,C and
536 B->A. To break the loop, we use a list of processed addresses in the dlist
539 After handling duplication, this function outputs the progenitor of the given
543 p the address we are interested in
544 pplist address of anchor of the list of addresses not to output
545 pdlist address of anchor of the list of processed addresses
546 first TRUE if this is the first address; set it FALSE afterwards
547 fd the file descriptor to write to
548 use_crlf to be passed on to write_chunk()
550 Returns: FALSE if writing failed
554 write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
555 BOOL *first, int fd, BOOL use_crlf)
560 /* Do nothing if we have already handled this address. If not, remember it
561 so that we don't handle it again. */
563 for (ppp = *pdlist; ppp; ppp = ppp->next) if (p == ppp->ptr) return TRUE;
565 ppp = store_get(sizeof(struct aci));
570 /* Now scan up the ancestry, checking for duplicates at each generation. */
572 for (pp = p;; pp = pp->parent)
575 for (dup = addr_duplicate; dup; dup = dup->next)
576 if (dup->dupof == pp) /* a dup of our address */
577 if (!write_env_to(dup, pplist, pdlist, first, fd, use_crlf))
579 if (!pp->parent) break;
582 /* Check to see if we have already output the progenitor. */
584 for (ppp = *pplist; ppp; ppp = ppp->next) if (pp == ppp->ptr) break;
585 if (ppp) return TRUE;
587 /* Remember what we have output, and output it. */
589 ppp = store_get(sizeof(struct aci));
594 if (!(*first) && !write_chunk(fd, US",\n ", 3, use_crlf)) return FALSE;
596 return write_chunk(fd, pp->address, Ustrlen(pp->address), use_crlf);
602 /* Add/remove/rewwrite headers, and send them plus the empty-line sparator.
608 addr (chain of) addresses (for extra headers), or NULL;
609 only the first address is used
610 fd file descriptor to write the message to
611 sendfn function for output
612 use_crlf turn NL into CR LF
613 rewrite_rules chain of header rewriting rules
614 rewrite_existflags flags for the rewriting rules
616 Returns: TRUE on success; FALSE on failure.
619 transport_headers_send(address_item *addr, int fd, uschar *add_headers, uschar *remove_headers,
620 BOOL (*sendfn)(int fd, uschar * s, int len, BOOL use_crlf),
621 BOOL use_crlf, rewrite_rule *rewrite_rules, int rewrite_existflags)
625 /* Then the message's headers. Don't write any that are flagged as "old";
626 that means they were rewritten, or are a record of envelope rewriting, or
627 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
628 match any entries therein. It is a colon-sep list; expand the items
629 separately and squash any empty ones.
630 Then check addr->prop.remove_headers too, provided that addr is not NULL. */
632 for (h = header_list; h; h = h->next) if (h->type != htype_old)
635 const uschar *list = remove_headers;
637 BOOL include_header = TRUE;
639 for (i = 0; i < 2; i++) /* For remove_headers && addr->prop.remove_headers */
643 int sep = ':'; /* This is specified as a colon-separated list */
645 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
650 if (!(s = expand_string(s)) && !expand_string_forcedfail)
652 errno = ERRNO_CHHEADER_FAIL;
655 len = s ? Ustrlen(s) : 0;
656 if (strncmpic(h->text, s, len) != 0) continue;
658 while (*ss == ' ' || *ss == '\t') ss++;
659 if (*ss == ':') break;
661 if (s != NULL) { include_header = FALSE; break; }
663 if (addr != NULL) list = addr->prop.remove_headers;
666 /* If this header is to be output, try to rewrite it if there are rewriting
673 void *reset_point = store_get(0);
676 if ((hh = rewrite_header(h, NULL, NULL, rewrite_rules, rewrite_existflags, FALSE)))
678 if (!sendfn(fd, hh->text, hh->slen, use_crlf)) return FALSE;
679 store_reset(reset_point);
680 continue; /* With the next header line */
684 /* Either no rewriting rules, or it didn't get rewritten */
686 if (!sendfn(fd, h->text, h->slen, use_crlf)) return FALSE;
693 DEBUG(D_transport) debug_printf("removed header line:\n%s---\n", h->text);
697 /* Add on any address-specific headers. If there are multiple addresses,
698 they will all have the same headers in order to be batched. The headers
699 are chained in reverse order of adding (so several addresses from the
700 same alias might share some of them) but we want to output them in the
701 opposite order. This is a bit tedious, but there shouldn't be very many
702 of them. We just walk the list twice, reversing the pointers each time,
703 but on the second time, write out the items.
705 Headers added to an address by a router are guaranteed to end with a newline.
711 header_line *hprev = addr->prop.extra_headers;
713 for (i = 0; i < 2; i++)
714 for (h = hprev, hprev = NULL; h; h = hnext)
721 if (!sendfn(fd, h->text, h->slen, use_crlf)) return FALSE;
723 debug_printf("added header line(s):\n%s---\n", h->text);
728 /* If a string containing additional headers exists it is a newline-sep
729 list. Expand each item and write out the result. This is done last so that
730 if it (deliberately or accidentally) isn't in header format, it won't mess
731 up any other headers. An empty string or a forced expansion failure are
732 noops. An added header string from a transport may not end with a newline;
733 add one if it does not. */
740 while ((s = string_nextinlist(CUSS &add_headers, &sep, NULL, 0)))
741 if ((s = expand_string(s)))
743 int len = Ustrlen(s);
746 if (!sendfn(fd, s, len, use_crlf)) return FALSE;
747 if (s[len-1] != '\n' && !sendfn(fd, US"\n", 1, use_crlf))
751 debug_printf("added header line:\n%s", s);
752 if (s[len-1] != '\n') debug_printf("\n");
753 debug_printf("---\n");
757 else if (!expand_string_forcedfail)
758 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
761 /* Separate headers from body with a blank line */
763 return sendfn(fd, US"\n", 1, use_crlf);
767 /*************************************************
768 * Write the message *
769 *************************************************/
771 /* This function writes the message to the given file descriptor. The headers
772 are in the in-store data structure, and the rest of the message is in the open
773 file descriptor deliver_datafile. Make sure we start it at the beginning.
775 . If add_return_path is TRUE, a "return-path:" header is added to the message,
776 containing the envelope sender's address.
778 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
779 giving the top-level envelope address that caused this delivery to happen.
781 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
782 message. It gives the time and date that delivery took place.
784 . If check_string is not null, the start of each line is checked for that
785 string. If it is found, it is replaced by escape_string. This used to be
786 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
788 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
790 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
791 any writing or reading error, leaving the code in errno intact. Error exits
792 can include timeouts for certain transports, which are requested by setting
793 transport_write_timeout non-zero.
796 addr (chain of) addresses (for extra headers), or NULL;
797 only the first address is used
798 fd file descriptor to write the message to
799 options bit-wise options:
800 add_return_path if TRUE, add a "return-path" header
801 add_envelope_to if TRUE, add a "envelope-to" header
802 add_delivery_date if TRUE, add a "delivery-date" header
803 use_crlf if TRUE, turn NL into CR LF
804 end_dot if TRUE, send a terminating "." line at the end
805 no_headers if TRUE, omit the headers
806 no_body if TRUE, omit the body
807 size_limit if > 0, this is a limit to the size of message written;
808 it is used when returning messages to their senders,
809 and is approximate rather than exact, owing to chunk
811 add_headers a string containing one or more headers to add; it is
812 expanded, and must be in correct RFC 822 format as
813 it is transmitted verbatim; NULL => no additions,
814 and so does empty string or forced expansion fail
815 remove_headers a colon-separated list of headers to remove, or NULL
816 check_string a string to check for at the start of lines, or NULL
817 escape_string a string to insert in front of any check string
818 rewrite_rules chain of header rewriting rules
819 rewrite_existflags flags for the rewriting rules
821 Returns: TRUE on success; FALSE (with errno) on failure.
822 In addition, the global variable transport_count
823 is incremented by the number of bytes written.
827 internal_transport_write_message(address_item *addr, int fd, int options,
828 int size_limit, uschar *add_headers, uschar *remove_headers, uschar *check_string,
829 uschar *escape_string, rewrite_rule *rewrite_rules, int rewrite_existflags)
833 BOOL use_crlf = (options & topt_use_crlf) != 0;
835 /* Initialize pointer in output buffer. */
837 chunk_ptr = deliver_out_buffer;
839 /* Set up the data for start-of-line data checking and escaping */
841 nl_partial_match = -1;
842 if (check_string && escape_string)
844 nl_check = check_string;
845 nl_check_length = Ustrlen(nl_check);
846 nl_escape = escape_string;
847 nl_escape_length = Ustrlen(nl_escape);
850 nl_check_length = nl_escape_length = 0;
852 /* Whether the escaping mechanism is applied to headers or not is controlled by
853 an option (set for SMTP, not otherwise). Negate the length if not wanted till
854 after the headers. */
856 if (!(options & topt_escape_headers))
857 nl_check_length = -nl_check_length;
859 /* Write the headers if required, including any that have to be added. If there
860 are header rewriting rules, apply them. */
862 if (!(options & topt_no_headers))
864 /* Add return-path: if requested. */
866 if (options & topt_add_return_path)
868 uschar buffer[ADDRESS_MAXLENGTH + 20];
869 int n = sprintf(CS buffer, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH,
871 if (!write_chunk(fd, buffer, n, use_crlf)) return FALSE;
874 /* Add envelope-to: if requested */
876 if (options & topt_add_envelope_to)
880 struct aci *plist = NULL;
881 struct aci *dlist = NULL;
882 void *reset_point = store_get(0);
884 if (!write_chunk(fd, US"Envelope-to: ", 13, use_crlf)) return FALSE;
886 /* Pick up from all the addresses. The plist and dlist variables are
887 anchors for lists of addresses already handled; they have to be defined at
888 this level becuase write_env_to() calls itself recursively. */
890 for (p = addr; p; p = p->next)
891 if (!write_env_to(p, &plist, &dlist, &first, fd, use_crlf))
894 /* Add a final newline and reset the store used for tracking duplicates */
896 if (!write_chunk(fd, US"\n", 1, use_crlf)) return FALSE;
897 store_reset(reset_point);
900 /* Add delivery-date: if requested. */
902 if ((options & topt_add_delivery_date) != 0)
905 int n = sprintf(CS buffer, "Delivery-date: %s\n", tod_stamp(tod_full));
906 if (!write_chunk(fd, buffer, n, use_crlf)) return FALSE;
909 /* Then the message's headers. Don't write any that are flagged as "old";
910 that means they were rewritten, or are a record of envelope rewriting, or
911 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
912 match any entries therein. Then check addr->prop.remove_headers too, provided that
914 if (!transport_headers_send(addr, fd, add_headers, remove_headers, &write_chunk,
915 use_crlf, rewrite_rules, rewrite_existflags))
919 /* If the body is required, ensure that the data for check strings (formerly
920 the "from hack") is enabled by negating the length if necessary. (It will be
921 negative in cases where it isn't to apply to the headers). Then ensure the body
922 is positioned at the start of its file (following the message id), then write
923 it, applying the size limit if required. */
925 if (!(options & topt_no_body))
927 nl_check_length = abs(nl_check_length);
928 nl_partial_match = 0;
929 if (lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET) < 0)
931 while ((len = read(deliver_datafile, deliver_in_buffer,
932 DELIVER_IN_BUFFER_SIZE)) > 0)
934 if (!write_chunk(fd, deliver_in_buffer, len, use_crlf)) return FALSE;
938 if (written > size_limit)
940 len = 0; /* Pretend EOF */
946 /* A read error on the body will have left len == -1 and errno set. */
948 if (len != 0) return FALSE;
951 /* Finished with the check string */
953 nl_check_length = nl_escape_length = 0;
955 /* If requested, add a terminating "." line (SMTP output). */
957 if (options & topt_end_dot && !write_chunk(fd, US".\n", 2, use_crlf))
960 /* Write out any remaining data in the buffer before returning. */
962 return (len = chunk_ptr - deliver_out_buffer) <= 0 ||
963 transport_write_block(fd, deliver_out_buffer, len);
969 /***************************************************************************************************
970 * External interface to write the message, while signing it with DKIM and/or Domainkeys *
971 ***************************************************************************************************/
973 /* This function is a wrapper around transport_write_message().
974 It is only called from the smtp transport if DKIM or Domainkeys support
975 is compiled in. The function sets up a replacement fd into a -K file,
976 then calls the normal function. This way, the exact bits that exim would
977 have put "on the wire" will end up in the file (except for TLS
978 encapsulation, which is the very very last thing). When we are done
979 signing the file, send the signed message down the original fd (or TLS fd).
982 as for internal_transport_write_message() above, with additional arguments
985 Returns: TRUE on success; FALSE (with errno) for any failure
989 dkim_transport_write_message(address_item *addr, int out_fd, int options,
990 uschar *add_headers, uschar *remove_headers,
991 uschar *check_string, uschar *escape_string, rewrite_rule *rewrite_rules,
992 int rewrite_existflags, struct ob_dkim * dkim)
997 uschar * dkim_spool_name;
1000 uschar *dkim_signature = NULL;
1003 /* If we can't sign, just call the original function. */
1005 if (!(dkim->dkim_private_key && dkim->dkim_domain && dkim->dkim_selector))
1006 return transport_write_message(addr, out_fd, options,
1007 0, add_headers, remove_headers,
1008 check_string, escape_string, rewrite_rules,
1009 rewrite_existflags);
1011 dkim_spool_name = spool_fname(US"input", message_subdir, message_id,
1012 string_sprintf("-%d-K", (int)getpid()));
1014 if ((dkim_fd = Uopen(dkim_spool_name, O_RDWR|O_CREAT|O_TRUNC, SPOOL_MODE)) < 0)
1016 /* Can't create spool file. Ugh. */
1022 /* Call original function to write the -K file; does the CRLF expansion */
1024 rc = transport_write_message(addr, dkim_fd, options,
1025 0, add_headers, remove_headers,
1026 check_string, escape_string, rewrite_rules,
1027 rewrite_existflags);
1029 /* Save error state. We must clean up before returning. */
1036 if (dkim->dkim_private_key && dkim->dkim_domain && dkim->dkim_selector)
1038 /* Rewind file and feed it to the goats^W DKIM lib */
1039 lseek(dkim_fd, 0, SEEK_SET);
1040 dkim_signature = dkim_exim_sign(dkim_fd,
1041 dkim->dkim_private_key,
1043 dkim->dkim_selector,
1045 dkim->dkim_sign_headers);
1046 if (!dkim_signature)
1048 if (dkim->dkim_strict)
1050 uschar *dkim_strict_result = expand_string(dkim->dkim_strict);
1051 if (dkim_strict_result)
1052 if ( (strcmpic(dkim->dkim_strict,US"1") == 0) ||
1053 (strcmpic(dkim->dkim_strict,US"true") == 0) )
1055 /* Set errno to something halfway meaningful */
1056 save_errno = EACCES;
1057 log_write(0, LOG_MAIN, "DKIM: message could not be signed,"
1058 " and dkim_strict is set. Deferring message delivery.");
1067 int siglen = Ustrlen(dkim_signature);
1071 wwritten = tls_out.active == out_fd
1072 ? tls_write(FALSE, dkim_signature, siglen)
1073 : write(out_fd, dkim_signature, siglen);
1075 wwritten = write(out_fd, dkim_signature, siglen);
1079 /* error, bail out */
1085 dkim_signature += wwritten;
1090 #ifdef HAVE_LINUX_SENDFILE
1091 /* We can use sendfile() to shove the file contents
1092 to the socket. However only if we don't use TLS,
1093 as then there's another layer of indirection
1094 before the data finally hits the socket. */
1095 if (tls_out.active != out_fd)
1100 k_file_size = lseek(dkim_fd, 0, SEEK_END); /* Fetch file size */
1103 lseek(dkim_fd, 0, SEEK_SET);
1105 while(copied >= 0 && offset < k_file_size)
1106 copied = sendfile(out_fd, dkim_fd, &offset, k_file_size - offset);
1119 lseek(dkim_fd, 0, SEEK_SET);
1121 /* Send file down the original fd */
1122 while((sread = read(dkim_fd, deliver_out_buffer, DELIVER_OUT_BUFFER_SIZE)) >0)
1124 char *p = deliver_out_buffer;
1125 /* write the chunk */
1130 wwritten = tls_out.active == out_fd
1131 ? tls_write(FALSE, US p, sread)
1132 : write(out_fd, p, sread);
1134 wwritten = write(out_fd, p, sread);
1138 /* error, bail out */
1156 /* unlink -K file */
1157 (void)close(dkim_fd);
1158 Uunlink(dkim_spool_name);
1167 /*************************************************
1168 * External interface to write the message *
1169 *************************************************/
1171 /* If there is no filtering required, call the internal function above to do
1172 the real work, passing over all the arguments from this function. Otherwise,
1173 set up a filtering process, fork another process to call the internal function
1174 to write to the filter, and in this process just suck from the filter and write
1175 down the given fd. At the end, tidy up the pipes and the processes.
1177 Arguments: as for internal_transport_write_message() above
1179 Returns: TRUE on success; FALSE (with errno) for any failure
1180 transport_count is incremented by the number of bytes written
1184 transport_write_message(address_item *addr, int fd, int options,
1185 int size_limit, uschar *add_headers, uschar *remove_headers,
1186 uschar *check_string, uschar *escape_string, rewrite_rule *rewrite_rules,
1187 int rewrite_existflags)
1190 BOOL last_filter_was_NL = TRUE;
1191 int rc, len, yield, fd_read, fd_write, save_errno;
1192 int pfd[2] = {-1, -1};
1193 pid_t filter_pid, write_pid;
1195 transport_filter_timed_out = FALSE;
1197 /* If there is no filter command set up, call the internal function that does
1198 the actual work, passing it the incoming fd, and return its result. */
1200 if ( !transport_filter_argv
1201 || !*transport_filter_argv
1202 || !**transport_filter_argv
1204 return internal_transport_write_message(addr, fd, options, size_limit,
1205 add_headers, remove_headers, check_string, escape_string,
1206 rewrite_rules, rewrite_existflags);
1208 /* Otherwise the message must be written to a filter process and read back
1209 before being written to the incoming fd. First set up the special processing to
1210 be done during the copying. */
1212 use_crlf = (options & topt_use_crlf) != 0;
1213 nl_partial_match = -1;
1215 if (check_string != NULL && escape_string != NULL)
1217 nl_check = check_string;
1218 nl_check_length = Ustrlen(nl_check);
1219 nl_escape = escape_string;
1220 nl_escape_length = Ustrlen(nl_escape);
1222 else nl_check_length = nl_escape_length = 0;
1224 /* Start up a subprocess to run the command. Ensure that our main fd will
1225 be closed when the subprocess execs, but remove the flag afterwards.
1226 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1227 process to deliver another message.) We get back stdin/stdout file descriptors.
1228 If the process creation failed, give an error return. */
1234 write_pid = (pid_t)(-1);
1236 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
1237 filter_pid = child_open(USS transport_filter_argv, NULL, 077,
1238 &fd_write, &fd_read, FALSE);
1239 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) & ~FD_CLOEXEC);
1240 if (filter_pid < 0) goto TIDY_UP; /* errno set */
1243 debug_printf("process %d running as transport filter: write=%d read=%d\n",
1244 (int)filter_pid, fd_write, fd_read);
1246 /* Fork subprocess to write the message to the filter, and return the result
1247 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1248 smtp dots, or check string processing. */
1250 if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1251 if ((write_pid = fork()) == 0)
1254 (void)close(fd_read);
1255 (void)close(pfd[pipe_read]);
1256 nl_check_length = nl_escape_length = 0;
1257 rc = internal_transport_write_message(addr, fd_write,
1258 (options & ~(topt_use_crlf | topt_end_dot)),
1259 size_limit, add_headers, remove_headers, NULL, NULL,
1260 rewrite_rules, rewrite_existflags);
1262 if ( write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1264 || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1266 || write(pfd[pipe_write], (void *)&(addr->more_errno), sizeof(int))
1269 rc = FALSE; /* compiler quietening */
1274 /* Parent process: close our copy of the writing subprocess' pipes. */
1276 (void)close(pfd[pipe_write]);
1277 (void)close(fd_write);
1280 /* Writing process creation failed */
1284 errno = save_errno; /* restore */
1288 /* When testing, let the subprocess get going */
1290 if (running_in_test_harness) millisleep(250);
1293 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1295 /* Copy the message from the filter to the output fd. A read error leaves len
1296 == -1 and errno set. We need to apply a timeout to the read, to cope with
1297 the case when the filter gets stuck, but it can be quite a long one. The
1298 default is 5m, but this is now configurable. */
1300 DEBUG(D_transport) debug_printf("copying from the filter\n");
1302 /* Copy the output of the filter, remembering if the last character was NL. If
1303 no data is returned, that counts as "ended with NL" (default setting of the
1304 variable is TRUE). */
1306 chunk_ptr = deliver_out_buffer;
1310 sigalrm_seen = FALSE;
1311 alarm(transport_filter_timeout);
1312 len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1317 transport_filter_timed_out = TRUE;
1321 /* If the read was successful, write the block down the original fd,
1322 remembering whether it ends in \n or not. */
1326 if (!write_chunk(fd, deliver_in_buffer, len, use_crlf)) goto TIDY_UP;
1327 last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1330 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1334 if (len == 0) yield = TRUE;
1339 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1340 to something. Ensure the pipes are all closed and the processes are removed. If
1341 there has been an error, kill the processes before waiting for them, just to be
1342 sure. Also apply a paranoia timeout. */
1347 (void)close(fd_read);
1348 if (fd_write > 0) (void)close(fd_write);
1352 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1353 if (write_pid > 0) kill(write_pid, SIGKILL);
1356 /* Wait for the filter process to complete. */
1358 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1359 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1362 save_errno = ERRNO_FILTER_FAIL;
1363 addr->more_errno = rc;
1364 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1367 /* Wait for the writing process to complete. If it ends successfully,
1368 read the results from its pipe, provided we haven't already had a filter
1371 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1374 rc = child_close(write_pid, 30);
1380 int dummy = read(pfd[pipe_read], (void *)&ok, sizeof(BOOL));
1383 dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1384 dummy = read(pfd[pipe_read], (void *)&(addr->more_errno), sizeof(int));
1391 save_errno = ERRNO_FILTER_FAIL;
1392 addr->more_errno = rc;
1393 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1397 (void)close(pfd[pipe_read]);
1399 /* If there have been no problems we can now add the terminating "." if this is
1400 SMTP output, turning off escaping beforehand. If the last character from the
1401 filter was not NL, insert a NL to make the SMTP protocol work. */
1405 nl_check_length = nl_escape_length = 0;
1406 if ( options & topt_end_dot
1407 && ( last_filter_was_NL
1408 ? !write_chunk(fd, US".\n", 2, options)
1409 : !write_chunk(fd, US"\n.\n", 3, options)
1413 /* Write out any remaining data in the buffer. */
1416 yield = (len = chunk_ptr - deliver_out_buffer) <= 0
1417 || transport_write_block(fd, deliver_out_buffer, len);
1420 errno = save_errno; /* From some earlier error */
1424 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1426 debug_printf("errno=%d more_errno=%d\n", errno, addr->more_errno);
1436 /*************************************************
1437 * Update waiting database *
1438 *************************************************/
1440 /* This is called when an address is deferred by remote transports that are
1441 capable of sending more than one message over one connection. A database is
1442 maintained for each transport, keeping track of which messages are waiting for
1443 which hosts. The transport can then consult this when eventually a successful
1444 delivery happens, and if it finds that another message is waiting for the same
1445 host, it can fire up a new process to deal with it using the same connection.
1447 The database records are keyed by host name. They can get full if there are
1448 lots of messages waiting, and so there is a continuation mechanism for them.
1450 Each record contains a list of message ids, packed end to end without any
1451 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1452 in this record, and the sequence field says if there are any other records for
1453 this host. If the sequence field is 0, there are none. If it is 1, then another
1454 record with the name <hostname>:0 exists; if it is 2, then two other records
1455 with sequence numbers 0 and 1 exist, and so on.
1457 Currently, an exhaustive search of all continuation records has to be done to
1458 determine whether to add a message id to a given record. This shouldn't be
1459 too bad except in extreme cases. I can't figure out a *simple* way of doing
1462 Old records should eventually get swept up by the exim_tidydb utility.
1465 hostlist list of hosts that this message could be sent to
1466 tpname name of the transport
1472 transport_update_waiting(host_item *hostlist, uschar *tpname)
1475 const uschar *prevname = US"";
1480 DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1482 /* Open the database for this transport */
1484 sprintf(CS buffer, "wait-%.200s", tpname);
1485 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1486 if (dbm_file == NULL) return;
1488 /* Scan the list of hosts for which this message is waiting, and ensure
1489 that the message id is in each host record. */
1491 for (host = hostlist; host!= NULL; host = host->next)
1493 BOOL already = FALSE;
1494 dbdata_wait *host_record;
1498 /* Skip if this is the same host as we just processed; otherwise remember
1499 the name for next time. */
1501 if (Ustrcmp(prevname, host->name) == 0) continue;
1502 prevname = host->name;
1504 /* Look up the host record; if there isn't one, make an empty one. */
1506 host_record = dbfn_read(dbm_file, host->name);
1507 if (host_record == NULL)
1509 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH);
1510 host_record->count = host_record->sequence = 0;
1513 /* Compute the current length */
1515 host_length = host_record->count * MESSAGE_ID_LENGTH;
1517 /* Search the record to see if the current message is already in it. */
1519 for (s = host_record->text; s < host_record->text + host_length;
1520 s += MESSAGE_ID_LENGTH)
1522 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1523 { already = TRUE; break; }
1526 /* If we haven't found this message in the main record, search any
1527 continuation records that exist. */
1529 for (i = host_record->sequence - 1; i >= 0 && !already; i--)
1532 sprintf(CS buffer, "%.200s:%d", host->name, i);
1533 cont = dbfn_read(dbm_file, buffer);
1536 int clen = cont->count * MESSAGE_ID_LENGTH;
1537 for (s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1539 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1540 { already = TRUE; break; }
1545 /* If this message is already in a record, no need to update. */
1549 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1554 /* If this record is full, write it out with a new name constructed
1555 from the sequence number, increase the sequence number, and empty
1558 if (host_record->count >= WAIT_NAME_MAX)
1560 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1561 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1562 host_record->sequence++;
1563 host_record->count = 0;
1567 /* If this record is not full, increase the size of the record to
1568 allow for one new message id. */
1573 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH);
1574 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1578 /* Now add the new name on the end */
1580 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1581 host_record->count++;
1582 host_length += MESSAGE_ID_LENGTH;
1584 /* Update the database */
1586 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1587 DEBUG(D_transport) debug_printf("added to list for %s\n", host->name);
1592 dbfn_close(dbm_file);
1598 /*************************************************
1599 * Test for waiting messages *
1600 *************************************************/
1602 /* This function is called by a remote transport which uses the previous
1603 function to remember which messages are waiting for which remote hosts. It's
1604 called after a successful delivery and its job is to check whether there is
1605 another message waiting for the same host. However, it doesn't do this if the
1606 current continue sequence is greater than the maximum supplied as an argument,
1607 or greater than the global connection_max_messages, which, if set, overrides.
1610 transport_name name of the transport
1611 hostname name of the host
1612 local_message_max maximum number of messages down one connection
1613 as set by the caller transport
1614 new_message_id set to the message id of a waiting message
1615 more set TRUE if there are yet more messages waiting
1616 oicf_func function to call to validate if it is ok to send
1617 to this message_id from the current instance.
1618 oicf_data opaque data for oicf_func
1620 Returns: TRUE if new_message_id set; FALSE otherwise
1623 typedef struct msgq_s
1625 uschar message_id [MESSAGE_ID_LENGTH + 1];
1630 transport_check_waiting(const uschar *transport_name, const uschar *hostname,
1631 int local_message_max, uschar *new_message_id, BOOL *more, oicf oicf_func, void *oicf_data)
1633 dbdata_wait *host_record;
1640 struct stat statbuf;
1646 debug_printf("transport_check_waiting entered\n");
1647 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1648 continue_sequence, local_message_max, connection_max_messages);
1651 /* Do nothing if we have hit the maximum number that can be send down one
1654 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1655 if (local_message_max > 0 && continue_sequence >= local_message_max)
1658 debug_printf("max messages for one connection reached: returning\n");
1662 /* Open the waiting information database. */
1664 sprintf(CS buffer, "wait-%.200s", transport_name);
1665 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1666 if (dbm_file == NULL) return FALSE;
1668 /* See if there is a record for this host; if not, there's nothing to do. */
1670 if (!(host_record = dbfn_read(dbm_file, hostname)))
1672 dbfn_close(dbm_file);
1673 DEBUG(D_transport) debug_printf("no messages waiting for %s\n", hostname);
1677 /* If the data in the record looks corrupt, just log something and
1678 don't try to use it. */
1680 if (host_record->count > WAIT_NAME_MAX)
1682 dbfn_close(dbm_file);
1683 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1684 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1688 /* Scan the message ids in the record from the end towards the beginning,
1689 until one is found for which a spool file actually exists. If the record gets
1690 emptied, delete it and continue with any continuation records that may exist.
1693 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1694 but the 1 off will remain without it. This code now allows me to SKIP over
1695 a message I do not want to send out on this run. */
1697 host_length = host_record->count * MESSAGE_ID_LENGTH;
1703 int msgq_actual = 0;
1704 BOOL bFound = FALSE;
1705 BOOL bContinuation = FALSE;
1707 /* create an array to read entire message queue into memory for processing */
1709 msgq = (msgq_t*) malloc(sizeof(msgq_t) * host_record->count);
1710 msgq_count = host_record->count;
1711 msgq_actual = msgq_count;
1713 for (i = 0; i < host_record->count; ++i)
1715 msgq[i].bKeep = TRUE;
1717 Ustrncpy(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
1719 msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1722 /* first thing remove current message id if it exists */
1724 for (i = 0; i < msgq_count; ++i)
1725 if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1727 msgq[i].bKeep = FALSE;
1731 /* now find the next acceptable message_id */
1733 for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1737 subdir[0] = split_spool_directory ? msgq[i].message_id[5] : 0;
1740 if (Ustat(spool_fname(US"input", subdir, msgq[i].message_id, US"-D"),
1742 msgq[i].bKeep = FALSE;
1743 else if (!oicf_func || oicf_func(msgq[i].message_id, oicf_data))
1745 Ustrcpy(new_message_id, msgq[i].message_id);
1746 msgq[i].bKeep = FALSE;
1753 for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1757 /* reassemble the host record, based on removed message ids, from in
1760 if (msgq_actual <= 0)
1763 host_record->count = 0;
1767 host_length = msgq_actual * MESSAGE_ID_LENGTH;
1768 host_record->count = msgq_actual;
1770 if (msgq_actual < msgq_count)
1773 for (new_count = 0, i = 0; i < msgq_count; ++i)
1775 Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1776 msgq[i].message_id, MESSAGE_ID_LENGTH);
1778 host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1782 /* Jeremy: check for a continuation record, this code I do not know how to
1783 test but the code should work */
1785 while (host_length <= 0)
1788 dbdata_wait * newr = NULL;
1790 /* Search for a continuation */
1792 for (i = host_record->sequence - 1; i >= 0 && !newr; i--)
1794 sprintf(CS buffer, "%.200s:%d", hostname, i);
1795 newr = dbfn_read(dbm_file, buffer);
1798 /* If no continuation, delete the current and break the loop */
1802 dbfn_delete(dbm_file, hostname);
1806 /* Else replace the current with the continuation */
1808 dbfn_delete(dbm_file, buffer);
1810 host_length = host_record->count * MESSAGE_ID_LENGTH;
1812 bContinuation = TRUE;
1815 if (bFound) /* Usual exit from main loop */
1821 /* If host_length <= 0 we have emptied a record and not found a good message,
1822 and there are no continuation records. Otherwise there is a continuation
1823 record to process. */
1825 if (host_length <= 0)
1827 dbfn_close(dbm_file);
1828 DEBUG(D_transport) debug_printf("waiting messages already delivered\n");
1832 /* we were not able to find an acceptable message, nor was there a
1833 * continuation record. So bug out, outer logic will clean this up.
1838 Ustrcpy(new_message_id, message_id);
1839 dbfn_close(dbm_file);
1844 } /* we need to process a continuation record */
1846 /* Control gets here when an existing message has been encountered; its
1847 id is in new_message_id, and host_length is the revised length of the
1848 host record. If it is zero, the record has been removed. Update the
1849 record if required, close the database, and return TRUE. */
1851 if (host_length > 0)
1853 host_record->count = host_length/MESSAGE_ID_LENGTH;
1855 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1859 dbfn_close(dbm_file);
1863 /*************************************************
1864 * Deliver waiting message down same socket *
1865 *************************************************/
1867 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1868 get a clean delivery process, and to regain root privilege in cases where it
1869 has been given away.
1872 transport_name to pass to the new process
1875 id the new message to process
1876 socket_fd the connected socket
1878 Returns: FALSE if fork fails; TRUE otherwise
1882 transport_pass_socket(const uschar *transport_name, const uschar *hostname,
1883 const uschar *hostaddress, uschar *id, int socket_fd)
1888 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
1890 if ((pid = fork()) == 0)
1893 const uschar **argv;
1895 /* Disconnect entirely from the parent process. If we are running in the
1896 test harness, wait for a bit to allow the previous process time to finish,
1897 write the log, etc., so that the output is always in the same order for
1898 automatic comparison. */
1900 if ((pid = fork()) != 0) _exit(EXIT_SUCCESS);
1901 if (running_in_test_harness) sleep(1);
1903 /* Set up the calling arguments; use the standard function for the basics,
1904 but we have a number of extras that may be added. */
1906 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1908 if (smtp_use_dsn) argv[i++] = US"-MCD";
1910 if (smtp_authenticated) argv[i++] = US"-MCA";
1913 if (tls_offered) argv[i++] = US"-MCT";
1916 if (smtp_use_size) argv[i++] = US"-MCS";
1917 if (smtp_use_pipelining) argv[i++] = US"-MCP";
1919 if (queue_run_pid != (pid_t)0)
1921 argv[i++] = US"-MCQ";
1922 argv[i++] = string_sprintf("%d", queue_run_pid);
1923 argv[i++] = string_sprintf("%d", queue_run_pipe);
1926 argv[i++] = US"-MC";
1927 argv[i++] = US transport_name;
1928 argv[i++] = US hostname;
1929 argv[i++] = US hostaddress;
1930 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1934 /* Arrange for the channel to be on stdin. */
1938 (void)dup2(socket_fd, 0);
1939 (void)close(socket_fd);
1942 DEBUG(D_exec) debug_print_argv(argv);
1943 exim_nullstd(); /* Ensure std{out,err} exist */
1944 execv(CS argv[0], (char *const *)argv);
1946 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1947 _exit(errno); /* Note: must be _exit(), NOT exit() */
1950 /* If the process creation succeeded, wait for the first-level child, which
1951 immediately exits, leaving the second level process entirely disconnected from
1957 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
1958 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded\n");
1963 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
1971 /*************************************************
1972 * Set up direct (non-shell) command *
1973 *************************************************/
1975 /* This function is called when a command line is to be parsed and executed
1976 directly, without the use of /bin/sh. It is called by the pipe transport,
1977 the queryprogram router, and also from the main delivery code when setting up a
1978 transport filter process. The code for ETRN also makes use of this; in that
1979 case, no addresses are passed.
1982 argvptr pointer to anchor for argv vector
1983 cmd points to the command string (modified IN PLACE)
1984 expand_arguments true if expansion is to occur
1985 expand_failed error value to set if expansion fails; not relevant if
1987 addr chain of addresses, or NULL
1988 etext text for use in error messages
1989 errptr where to put error message if addr is NULL;
1990 otherwise it is put in the first address
1992 Returns: TRUE if all went well; otherwise an error will be
1993 set in the first address and FALSE returned
1997 transport_set_up_command(const uschar ***argvptr, uschar *cmd,
1998 BOOL expand_arguments, int expand_failed, address_item *addr,
1999 uschar *etext, uschar **errptr)
2002 const uschar **argv;
2004 int address_count = 0;
2008 /* Get store in which to build an argument list. Count the number of addresses
2009 supplied, and allow for that many arguments, plus an additional 60, which
2010 should be enough for anybody. Multiple addresses happen only when the local
2011 delivery batch option is set. */
2013 for (ad = addr; ad != NULL; ad = ad->next) address_count++;
2014 max_args = address_count + 60;
2015 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *));
2017 /* Split the command up into arguments terminated by white space. Lose
2018 trailing space at the start and end. Double-quoted arguments can contain \\ and
2019 \" escapes and so can be handled by the standard function; single-quoted
2020 arguments are verbatim. Copy each argument into a new string. */
2023 while (isspace(*s)) s++;
2025 while (*s != 0 && argcount < max_args)
2030 while (*ss != 0 && *ss != '\'') ss++;
2031 argv[argcount++] = ss = store_get(ss - s++);
2032 while (*s != 0 && *s != '\'') *ss++ = *s++;
2036 else argv[argcount++] = string_copy(string_dequote(CUSS &s));
2037 while (isspace(*s)) s++;
2040 argv[argcount] = (uschar *)0;
2042 /* If *s != 0 we have run out of argument slots. */
2046 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2050 addr->transport_return = FAIL;
2051 addr->message = msg;
2057 /* Expand each individual argument if required. Expansion happens for pipes set
2058 up in filter files and with directly-supplied commands. It does not happen if
2059 the pipe comes from a traditional .forward file. A failing expansion is a big
2060 disaster if the command came from Exim's configuration; if it came from a user
2061 it is just a normal failure. The expand_failed value is used as the error value
2062 to cater for these two cases.
2064 An argument consisting just of the text "$pipe_addresses" is treated specially.
2065 It is not passed to the general expansion function. Instead, it is replaced by
2066 a number of arguments, one for each address. This avoids problems with shell
2067 metacharacters and spaces in addresses.
2069 If the parent of the top address has an original part of "system-filter", this
2070 pipe was set up by the system filter, and we can permit the expansion of
2075 debug_printf("direct command:\n");
2076 for (i = 0; argv[i] != (uschar *)0; i++)
2077 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2080 if (expand_arguments)
2082 BOOL allow_dollar_recipients = addr != NULL &&
2083 addr->parent != NULL &&
2084 Ustrcmp(addr->parent->address, "system-filter") == 0;
2086 for (i = 0; argv[i] != (uschar *)0; i++)
2089 /* Handle special fudge for passing an address list */
2092 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2093 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2097 if (argcount + address_count - 1 > max_args)
2099 addr->transport_return = FAIL;
2100 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2101 "in %s", cmd, etext);
2105 additional = address_count - 1;
2107 memmove(argv + i + 1 + additional, argv + i + 1,
2108 (argcount - i)*sizeof(uschar *));
2110 for (ad = addr; ad != NULL; ad = ad->next) {
2111 argv[i++] = ad->address;
2115 /* Subtract one since we replace $pipe_addresses */
2120 /* Handle special case of $address_pipe when af_force_command is set */
2122 else if (addr != NULL && testflag(addr,af_force_command) &&
2123 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2124 Ustrcmp(argv[i], "${address_pipe}") == 0))
2127 int address_pipe_argcount = 0;
2128 int address_pipe_max_args;
2129 uschar **address_pipe_argv;
2131 /* We can never have more then the argv we will be loading into */
2132 address_pipe_max_args = max_args - argcount + 1;
2135 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2137 /* We allocate an additional for (uschar *)0 */
2138 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *));
2140 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2141 s = expand_string(addr->local_part + 1);
2143 if (s == NULL || *s == '\0')
2145 addr->transport_return = FAIL;
2146 addr->message = string_sprintf("Expansion of \"%s\" "
2147 "from command \"%s\" in %s failed: %s",
2148 (addr->local_part + 1), cmd, etext, expand_string_message);
2152 while (isspace(*s)) s++; /* strip leading space */
2154 while (*s != 0 && address_pipe_argcount < address_pipe_max_args)
2159 while (*ss != 0 && *ss != '\'') ss++;
2160 address_pipe_argv[address_pipe_argcount++] = ss = store_get(ss - s++);
2161 while (*s != 0 && *s != '\'') *ss++ = *s++;
2165 else address_pipe_argv[address_pipe_argcount++] =
2166 string_copy(string_dequote(CUSS &s));
2167 while (isspace(*s)) s++; /* strip space after arg */
2170 address_pipe_argv[address_pipe_argcount] = (uschar *)0;
2172 /* If *s != 0 we have run out of argument slots. */
2175 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2176 "\"%s\" in %s", addr->local_part + 1, etext);
2179 addr->transport_return = FAIL;
2180 addr->message = msg;
2186 /* address_pipe_argcount - 1
2187 * because we are replacing $address_pipe in the argument list
2188 * with the first thing it expands to */
2189 if (argcount + address_pipe_argcount - 1 > max_args)
2191 addr->transport_return = FAIL;
2192 addr->message = string_sprintf("Too many arguments to command "
2193 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2197 /* If we are not just able to replace the slot that contained
2198 * $address_pipe (address_pipe_argcount == 1)
2199 * We have to move the existing argv by address_pipe_argcount - 1
2200 * Visually if address_pipe_argcount == 2:
2201 * [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2202 * [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0]
2204 if (address_pipe_argcount > 1)
2206 /* current position + additonal args */
2207 argv + i + address_pipe_argcount,
2208 /* current position + 1 (for the (uschar *)0 at the end) */
2210 /* -1 for the (uschar *)0 at the end)*/
2211 (argcount - i)*sizeof(uschar *)
2214 /* Now we fill in the slots we just moved argv out of
2215 * [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0]
2217 for (address_pipe_i = 0;
2218 address_pipe_argv[address_pipe_i] != (uschar *)0;
2221 argv[i++] = address_pipe_argv[address_pipe_i];
2225 /* Subtract one since we replace $address_pipe */
2230 /* Handle normal expansion string */
2234 const uschar *expanded_arg;
2235 enable_dollar_recipients = allow_dollar_recipients;
2236 expanded_arg = expand_cstring(argv[i]);
2237 enable_dollar_recipients = FALSE;
2239 if (expanded_arg == NULL)
2241 uschar *msg = string_sprintf("Expansion of \"%s\" "
2242 "from command \"%s\" in %s failed: %s",
2243 argv[i], cmd, etext, expand_string_message);
2246 addr->transport_return = expand_failed;
2247 addr->message = msg;
2252 argv[i] = expanded_arg;
2258 debug_printf("direct command after expansion:\n");
2259 for (i = 0; argv[i] != (uschar *)0; i++)
2260 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2269 /* End of transport.c */