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;
372 register uschar *ptr;
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 != NULL; ppp = ppp->next)
564 { if (p == ppp->ptr) return TRUE; }
566 ppp = store_get(sizeof(struct aci));
571 /* Now scan up the ancestry, checking for duplicates at each generation. */
573 for (pp = p;; pp = pp->parent)
576 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
578 if (dup->dupof != pp) continue; /* Not a dup of our address */
579 if (!write_env_to(dup, pplist, pdlist, first, fd, use_crlf)) return FALSE;
581 if (pp->parent == NULL) break;
584 /* Check to see if we have already output the progenitor. */
586 for (ppp = *pplist; ppp != NULL; ppp = ppp->next)
587 { if (pp == ppp->ptr) break; }
588 if (ppp != NULL) return TRUE;
590 /* Remember what we have output, and output it. */
592 ppp = store_get(sizeof(struct aci));
597 if (!(*first) && !write_chunk(fd, US",\n ", 3, use_crlf)) return FALSE;
599 return write_chunk(fd, pp->address, Ustrlen(pp->address), use_crlf);
605 /* Add/remove/rewwrite headers, and send them plus the empty-line sparator.
611 addr (chain of) addresses (for extra headers), or NULL;
612 only the first address is used
613 fd file descriptor to write the message to
614 sendfn function for output
615 use_crlf turn NL into CR LF
616 rewrite_rules chain of header rewriting rules
617 rewrite_existflags flags for the rewriting rules
619 Returns: TRUE on success; FALSE on failure.
622 transport_headers_send(address_item *addr, int fd, uschar *add_headers, uschar *remove_headers,
623 BOOL (*sendfn)(int fd, uschar * s, int len, BOOL use_crlf),
624 BOOL use_crlf, rewrite_rule *rewrite_rules, int rewrite_existflags)
628 /* Then the message's headers. Don't write any that are flagged as "old";
629 that means they were rewritten, or are a record of envelope rewriting, or
630 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
631 match any entries therein. It is a colon-sep list; expand the items
632 separately and squash any empty ones.
633 Then check addr->prop.remove_headers too, provided that addr is not NULL. */
635 for (h = header_list; h != NULL; h = h->next) if (h->type != htype_old)
638 const uschar *list = remove_headers;
640 BOOL include_header = TRUE;
642 for (i = 0; i < 2; i++) /* For remove_headers && addr->prop.remove_headers */
646 int sep = ':'; /* This is specified as a colon-separated list */
648 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
653 if (!(s = expand_string(s)) && !expand_string_forcedfail)
655 errno = ERRNO_CHHEADER_FAIL;
658 len = s ? Ustrlen(s) : 0;
659 if (strncmpic(h->text, s, len) != 0) continue;
661 while (*ss == ' ' || *ss == '\t') ss++;
662 if (*ss == ':') break;
664 if (s != NULL) { include_header = FALSE; break; }
666 if (addr != NULL) list = addr->prop.remove_headers;
669 /* If this header is to be output, try to rewrite it if there are rewriting
676 void *reset_point = store_get(0);
679 if ((hh = rewrite_header(h, NULL, NULL, rewrite_rules, rewrite_existflags, FALSE)))
681 if (!sendfn(fd, hh->text, hh->slen, use_crlf)) return FALSE;
682 store_reset(reset_point);
683 continue; /* With the next header line */
687 /* Either no rewriting rules, or it didn't get rewritten */
689 if (!sendfn(fd, h->text, h->slen, use_crlf)) return FALSE;
696 DEBUG(D_transport) debug_printf("removed header line:\n%s---\n", h->text);
700 /* Add on any address-specific headers. If there are multiple addresses,
701 they will all have the same headers in order to be batched. The headers
702 are chained in reverse order of adding (so several addresses from the
703 same alias might share some of them) but we want to output them in the
704 opposite order. This is a bit tedious, but there shouldn't be very many
705 of them. We just walk the list twice, reversing the pointers each time,
706 but on the second time, write out the items.
708 Headers added to an address by a router are guaranteed to end with a newline.
714 header_line *hprev = addr->prop.extra_headers;
716 for (i = 0; i < 2; i++)
718 for (h = hprev, hprev = NULL; h != NULL; h = hnext)
725 if (!sendfn(fd, h->text, h->slen, use_crlf)) return FALSE;
727 debug_printf("added header line(s):\n%s---\n", h->text);
733 /* If a string containing additional headers exists it is a newline-sep
734 list. Expand each item and write out the result. This is done last so that
735 if it (deliberately or accidentally) isn't in header format, it won't mess
736 up any other headers. An empty string or a forced expansion failure are
737 noops. An added header string from a transport may not end with a newline;
738 add one if it does not. */
745 while ((s = string_nextinlist(CUSS &add_headers, &sep, NULL, 0)))
746 if (!(s = expand_string(s)))
748 if (!expand_string_forcedfail)
749 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
753 int len = Ustrlen(s);
756 if (!sendfn(fd, s, len, use_crlf)) return FALSE;
757 if (s[len-1] != '\n' && !sendfn(fd, US"\n", 1, use_crlf))
761 debug_printf("added header line:\n%s", s);
762 if (s[len-1] != '\n') debug_printf("\n");
763 debug_printf("---\n");
769 /* Separate headers from body with a blank line */
771 return sendfn(fd, US"\n", 1, use_crlf);
775 /*************************************************
776 * Write the message *
777 *************************************************/
779 /* This function writes the message to the given file descriptor. The headers
780 are in the in-store data structure, and the rest of the message is in the open
781 file descriptor deliver_datafile. Make sure we start it at the beginning.
783 . If add_return_path is TRUE, a "return-path:" header is added to the message,
784 containing the envelope sender's address.
786 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
787 giving the top-level envelope address that caused this delivery to happen.
789 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
790 message. It gives the time and date that delivery took place.
792 . If check_string is not null, the start of each line is checked for that
793 string. If it is found, it is replaced by escape_string. This used to be
794 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
796 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
798 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
799 any writing or reading error, leaving the code in errno intact. Error exits
800 can include timeouts for certain transports, which are requested by setting
801 transport_write_timeout non-zero.
804 addr (chain of) addresses (for extra headers), or NULL;
805 only the first address is used
806 fd file descriptor to write the message to
807 options bit-wise options:
808 add_return_path if TRUE, add a "return-path" header
809 add_envelope_to if TRUE, add a "envelope-to" header
810 add_delivery_date if TRUE, add a "delivery-date" header
811 use_crlf if TRUE, turn NL into CR LF
812 end_dot if TRUE, send a terminating "." line at the end
813 no_headers if TRUE, omit the headers
814 no_body if TRUE, omit the body
815 size_limit if > 0, this is a limit to the size of message written;
816 it is used when returning messages to their senders,
817 and is approximate rather than exact, owing to chunk
819 add_headers a string containing one or more headers to add; it is
820 expanded, and must be in correct RFC 822 format as
821 it is transmitted verbatim; NULL => no additions,
822 and so does empty string or forced expansion fail
823 remove_headers a colon-separated list of headers to remove, or NULL
824 check_string a string to check for at the start of lines, or NULL
825 escape_string a string to insert in front of any check string
826 rewrite_rules chain of header rewriting rules
827 rewrite_existflags flags for the rewriting rules
829 Returns: TRUE on success; FALSE (with errno) on failure.
830 In addition, the global variable transport_count
831 is incremented by the number of bytes written.
835 internal_transport_write_message(address_item *addr, int fd, int options,
836 int size_limit, uschar *add_headers, uschar *remove_headers, uschar *check_string,
837 uschar *escape_string, rewrite_rule *rewrite_rules, int rewrite_existflags)
841 BOOL use_crlf = (options & topt_use_crlf) != 0;
843 /* Initialize pointer in output buffer. */
845 chunk_ptr = deliver_out_buffer;
847 /* Set up the data for start-of-line data checking and escaping */
849 nl_partial_match = -1;
850 if (check_string != NULL && escape_string != NULL)
852 nl_check = check_string;
853 nl_check_length = Ustrlen(nl_check);
854 nl_escape = escape_string;
855 nl_escape_length = Ustrlen(nl_escape);
857 else nl_check_length = nl_escape_length = 0;
859 /* Whether the escaping mechanism is applied to headers or not is controlled by
860 an option (set for SMTP, not otherwise). Negate the length if not wanted till
861 after the headers. */
863 if ((options & topt_escape_headers) == 0) nl_check_length = -nl_check_length;
865 /* Write the headers if required, including any that have to be added. If there
866 are header rewriting rules, apply them. */
868 if ((options & topt_no_headers) == 0)
870 /* Add return-path: if requested. */
872 if ((options & topt_add_return_path) != 0)
874 uschar buffer[ADDRESS_MAXLENGTH + 20];
875 sprintf(CS buffer, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH,
877 if (!write_chunk(fd, buffer, Ustrlen(buffer), use_crlf)) return FALSE;
880 /* Add envelope-to: if requested */
882 if ((options & topt_add_envelope_to) != 0)
886 struct aci *plist = NULL;
887 struct aci *dlist = NULL;
888 void *reset_point = store_get(0);
890 if (!write_chunk(fd, US"Envelope-to: ", 13, use_crlf)) return FALSE;
892 /* Pick up from all the addresses. The plist and dlist variables are
893 anchors for lists of addresses already handled; they have to be defined at
894 this level becuase write_env_to() calls itself recursively. */
896 for (p = addr; p != NULL; p = p->next)
898 if (!write_env_to(p, &plist, &dlist, &first, fd, use_crlf)) return FALSE;
901 /* Add a final newline and reset the store used for tracking duplicates */
903 if (!write_chunk(fd, US"\n", 1, use_crlf)) return FALSE;
904 store_reset(reset_point);
907 /* Add delivery-date: if requested. */
909 if ((options & topt_add_delivery_date) != 0)
912 sprintf(CS buffer, "Delivery-date: %s\n", tod_stamp(tod_full));
913 if (!write_chunk(fd, buffer, Ustrlen(buffer), use_crlf)) return FALSE;
916 /* Then the message's headers. Don't write any that are flagged as "old";
917 that means they were rewritten, or are a record of envelope rewriting, or
918 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
919 match any entries therein. Then check addr->prop.remove_headers too, provided that
921 if (!transport_headers_send(addr, fd, add_headers, remove_headers, &write_chunk,
922 use_crlf, rewrite_rules, rewrite_existflags))
926 /* If the body is required, ensure that the data for check strings (formerly
927 the "from hack") is enabled by negating the length if necessary. (It will be
928 negative in cases where it isn't to apply to the headers). Then ensure the body
929 is positioned at the start of its file (following the message id), then write
930 it, applying the size limit if required. */
932 if ((options & topt_no_body) == 0)
934 nl_check_length = abs(nl_check_length);
935 nl_partial_match = 0;
936 if (lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET) < 0)
938 while ((len = read(deliver_datafile, deliver_in_buffer,
939 DELIVER_IN_BUFFER_SIZE)) > 0)
941 if (!write_chunk(fd, deliver_in_buffer, len, use_crlf)) return FALSE;
945 if (written > size_limit)
947 len = 0; /* Pretend EOF */
953 /* A read error on the body will have left len == -1 and errno set. */
955 if (len != 0) return FALSE;
958 /* Finished with the check string */
960 nl_check_length = nl_escape_length = 0;
962 /* If requested, add a terminating "." line (SMTP output). */
964 if ((options & topt_end_dot) != 0 && !write_chunk(fd, US".\n", 2, use_crlf))
967 /* Write out any remaining data in the buffer before returning. */
969 return (len = chunk_ptr - deliver_out_buffer) <= 0 ||
970 transport_write_block(fd, deliver_out_buffer, len);
976 /***************************************************************************************************
977 * External interface to write the message, while signing it with DKIM and/or Domainkeys *
978 ***************************************************************************************************/
980 /* This function is a wrapper around transport_write_message().
981 It is only called from the smtp transport if DKIM or Domainkeys support
982 is compiled in. The function sets up a replacement fd into a -K file,
983 then calls the normal function. This way, the exact bits that exim would
984 have put "on the wire" will end up in the file (except for TLS
985 encapsulation, which is the very very last thing). When we are done
986 signing the file, send the signed message down the original fd (or TLS fd).
989 as for internal_transport_write_message() above, with additional arguments:
990 uschar *dkim_private_key DKIM: The private key to use (filename or
992 uschar *dkim_domain DKIM: The domain to use
993 uschar *dkim_selector DKIM: The selector to use.
994 uschar *dkim_canon DKIM: The canonalization scheme to use,
995 "simple" or "relaxed"
996 uschar *dkim_strict DKIM: What to do if signing fails:
997 1/true => throw error
998 0/false => send anyway
999 uschar *dkim_sign_headers DKIM: List of headers that should be included
1000 in signature generation
1002 Returns: TRUE on success; FALSE (with errno) for any failure
1006 dkim_transport_write_message(address_item *addr, int fd, int options,
1007 int size_limit, uschar *add_headers, uschar *remove_headers,
1008 uschar *check_string, uschar *escape_string, rewrite_rule *rewrite_rules,
1009 int rewrite_existflags, uschar *dkim_private_key, uschar *dkim_domain,
1010 uschar *dkim_selector, uschar *dkim_canon, uschar *dkim_strict, uschar *dkim_sign_headers
1016 uschar dkim_spool_name[256];
1020 uschar *dkim_signature = NULL;
1022 /* If we can't sign, just call the original function. */
1024 if (!(dkim_private_key && dkim_domain && dkim_selector))
1025 return transport_write_message(addr, fd, options,
1026 size_limit, add_headers, remove_headers,
1027 check_string, escape_string, rewrite_rules,
1028 rewrite_existflags);
1030 (void)string_format(dkim_spool_name, 256, "%s/input/%s/%s-%d-K",
1031 spool_directory, message_subdir, message_id, (int)getpid());
1033 if ((dkim_fd = Uopen(dkim_spool_name, O_RDWR|O_CREAT|O_TRUNC, SPOOL_MODE)) < 0)
1035 /* Can't create spool file. Ugh. */
1041 /* Call original function to write the -K file */
1043 rc = transport_write_message(addr, dkim_fd, options,
1044 size_limit, add_headers, remove_headers,
1045 check_string, escape_string, rewrite_rules,
1046 rewrite_existflags);
1048 /* Save error state. We must clean up before returning. */
1055 if (dkim_private_key && dkim_domain && dkim_selector)
1057 /* Rewind file and feed it to the goats^W DKIM lib */
1058 lseek(dkim_fd, 0, SEEK_SET);
1059 dkim_signature = dkim_exim_sign(dkim_fd,
1065 if (!dkim_signature)
1069 uschar *dkim_strict_result = expand_string(dkim_strict);
1070 if (dkim_strict_result)
1071 if ( (strcmpic(dkim_strict,US"1") == 0) ||
1072 (strcmpic(dkim_strict,US"true") == 0) )
1074 /* Set errno to something halfway meaningful */
1075 save_errno = EACCES;
1076 log_write(0, LOG_MAIN, "DKIM: message could not be signed,"
1077 " and dkim_strict is set. Deferring message delivery.");
1085 int siglen = Ustrlen(dkim_signature);
1089 wwritten = tls_out.active == fd
1090 ? tls_write(FALSE, dkim_signature, siglen)
1091 : write(fd, dkim_signature, siglen);
1093 wwritten = write(fd, dkim_signature, siglen);
1097 /* error, bail out */
1103 dkim_signature += wwritten;
1108 #ifdef HAVE_LINUX_SENDFILE
1109 /* We can use sendfile() to shove the file contents
1110 to the socket. However only if we don't use TLS,
1111 as then there's another layer of indirection
1112 before the data finally hits the socket. */
1113 if (tls_out.active != fd)
1115 off_t size = lseek(dkim_fd, 0, SEEK_END); /* Fetch file size */
1120 lseek(dkim_fd, 0, SEEK_SET);
1122 while(copied >= 0 && offset < size)
1123 copied = sendfile(fd, dkim_fd, &offset, size - offset);
1136 lseek(dkim_fd, 0, SEEK_SET);
1138 /* Send file down the original fd */
1139 while((sread = read(dkim_fd, sbuf, 2048)) > 0)
1142 /* write the chunk */
1147 wwritten = tls_out.active == fd
1148 ? tls_write(FALSE, US p, sread)
1149 : write(fd, p, sread);
1151 wwritten = write(fd, p, sread);
1155 /* error, bail out */
1173 /* unlink -K file */
1174 (void)close(dkim_fd);
1175 Uunlink(dkim_spool_name);
1184 /*************************************************
1185 * External interface to write the message *
1186 *************************************************/
1188 /* If there is no filtering required, call the internal function above to do
1189 the real work, passing over all the arguments from this function. Otherwise,
1190 set up a filtering process, fork another process to call the internal function
1191 to write to the filter, and in this process just suck from the filter and write
1192 down the given fd. At the end, tidy up the pipes and the processes.
1194 Arguments: as for internal_transport_write_message() above
1196 Returns: TRUE on success; FALSE (with errno) for any failure
1197 transport_count is incremented by the number of bytes written
1201 transport_write_message(address_item *addr, int fd, int options,
1202 int size_limit, uschar *add_headers, uschar *remove_headers,
1203 uschar *check_string, uschar *escape_string, rewrite_rule *rewrite_rules,
1204 int rewrite_existflags)
1207 BOOL last_filter_was_NL = TRUE;
1208 int rc, len, yield, fd_read, fd_write, save_errno;
1209 int pfd[2] = {-1, -1};
1210 pid_t filter_pid, write_pid;
1212 transport_filter_timed_out = FALSE;
1214 /* If there is no filter command set up, call the internal function that does
1215 the actual work, passing it the incoming fd, and return its result. */
1217 if ( !transport_filter_argv
1218 || !*transport_filter_argv
1219 || !**transport_filter_argv
1221 return internal_transport_write_message(addr, fd, options, size_limit,
1222 add_headers, remove_headers, check_string, escape_string,
1223 rewrite_rules, rewrite_existflags);
1225 /* Otherwise the message must be written to a filter process and read back
1226 before being written to the incoming fd. First set up the special processing to
1227 be done during the copying. */
1229 use_crlf = (options & topt_use_crlf) != 0;
1230 nl_partial_match = -1;
1232 if (check_string != NULL && escape_string != NULL)
1234 nl_check = check_string;
1235 nl_check_length = Ustrlen(nl_check);
1236 nl_escape = escape_string;
1237 nl_escape_length = Ustrlen(nl_escape);
1239 else nl_check_length = nl_escape_length = 0;
1241 /* Start up a subprocess to run the command. Ensure that our main fd will
1242 be closed when the subprocess execs, but remove the flag afterwards.
1243 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1244 process to deliver another message.) We get back stdin/stdout file descriptors.
1245 If the process creation failed, give an error return. */
1251 write_pid = (pid_t)(-1);
1253 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
1254 filter_pid = child_open(USS transport_filter_argv, NULL, 077,
1255 &fd_write, &fd_read, FALSE);
1256 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) & ~FD_CLOEXEC);
1257 if (filter_pid < 0) goto TIDY_UP; /* errno set */
1260 debug_printf("process %d running as transport filter: write=%d read=%d\n",
1261 (int)filter_pid, fd_write, fd_read);
1263 /* Fork subprocess to write the message to the filter, and return the result
1264 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1265 smtp dots, or check string processing. */
1267 if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1268 if ((write_pid = fork()) == 0)
1271 (void)close(fd_read);
1272 (void)close(pfd[pipe_read]);
1273 nl_check_length = nl_escape_length = 0;
1274 rc = internal_transport_write_message(addr, fd_write,
1275 (options & ~(topt_use_crlf | topt_end_dot)),
1276 size_limit, add_headers, remove_headers, NULL, NULL,
1277 rewrite_rules, rewrite_existflags);
1279 if ( write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1281 || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1283 || write(pfd[pipe_write], (void *)&(addr->more_errno), sizeof(int))
1286 rc = FALSE; /* compiler quietening */
1291 /* Parent process: close our copy of the writing subprocess' pipes. */
1293 (void)close(pfd[pipe_write]);
1294 (void)close(fd_write);
1297 /* Writing process creation failed */
1301 errno = save_errno; /* restore */
1305 /* When testing, let the subprocess get going */
1307 if (running_in_test_harness) millisleep(250);
1310 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1312 /* Copy the message from the filter to the output fd. A read error leaves len
1313 == -1 and errno set. We need to apply a timeout to the read, to cope with
1314 the case when the filter gets stuck, but it can be quite a long one. The
1315 default is 5m, but this is now configurable. */
1317 DEBUG(D_transport) debug_printf("copying from the filter\n");
1319 /* Copy the output of the filter, remembering if the last character was NL. If
1320 no data is returned, that counts as "ended with NL" (default setting of the
1321 variable is TRUE). */
1323 chunk_ptr = deliver_out_buffer;
1327 sigalrm_seen = FALSE;
1328 alarm(transport_filter_timeout);
1329 len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1334 transport_filter_timed_out = TRUE;
1338 /* If the read was successful, write the block down the original fd,
1339 remembering whether it ends in \n or not. */
1343 if (!write_chunk(fd, deliver_in_buffer, len, use_crlf)) goto TIDY_UP;
1344 last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1347 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1351 if (len == 0) yield = TRUE;
1356 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1357 to something. Ensure the pipes are all closed and the processes are removed. If
1358 there has been an error, kill the processes before waiting for them, just to be
1359 sure. Also apply a paranoia timeout. */
1364 (void)close(fd_read);
1365 if (fd_write > 0) (void)close(fd_write);
1369 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1370 if (write_pid > 0) kill(write_pid, SIGKILL);
1373 /* Wait for the filter process to complete. */
1375 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1376 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1379 save_errno = ERRNO_FILTER_FAIL;
1380 addr->more_errno = rc;
1381 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1384 /* Wait for the writing process to complete. If it ends successfully,
1385 read the results from its pipe, provided we haven't already had a filter
1388 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1391 rc = child_close(write_pid, 30);
1397 int dummy = read(pfd[pipe_read], (void *)&ok, sizeof(BOOL));
1400 dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1401 dummy = read(pfd[pipe_read], (void *)&(addr->more_errno), sizeof(int));
1408 save_errno = ERRNO_FILTER_FAIL;
1409 addr->more_errno = rc;
1410 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1414 (void)close(pfd[pipe_read]);
1416 /* If there have been no problems we can now add the terminating "." if this is
1417 SMTP output, turning off escaping beforehand. If the last character from the
1418 filter was not NL, insert a NL to make the SMTP protocol work. */
1422 nl_check_length = nl_escape_length = 0;
1423 if ((options & topt_end_dot) != 0 && (last_filter_was_NL?
1424 !write_chunk(fd, US".\n", 2, use_crlf) :
1425 !write_chunk(fd, US"\n.\n", 3, use_crlf)))
1430 /* Write out any remaining data in the buffer. */
1434 yield = (len = chunk_ptr - deliver_out_buffer) <= 0 ||
1435 transport_write_block(fd, deliver_out_buffer, len);
1438 else errno = save_errno; /* From some earlier error */
1442 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1444 debug_printf("errno=%d more_errno=%d\n", errno, addr->more_errno);
1454 /*************************************************
1455 * Update waiting database *
1456 *************************************************/
1458 /* This is called when an address is deferred by remote transports that are
1459 capable of sending more than one message over one connection. A database is
1460 maintained for each transport, keeping track of which messages are waiting for
1461 which hosts. The transport can then consult this when eventually a successful
1462 delivery happens, and if it finds that another message is waiting for the same
1463 host, it can fire up a new process to deal with it using the same connection.
1465 The database records are keyed by host name. They can get full if there are
1466 lots of messages waiting, and so there is a continuation mechanism for them.
1468 Each record contains a list of message ids, packed end to end without any
1469 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1470 in this record, and the sequence field says if there are any other records for
1471 this host. If the sequence field is 0, there are none. If it is 1, then another
1472 record with the name <hostname>:0 exists; if it is 2, then two other records
1473 with sequence numbers 0 and 1 exist, and so on.
1475 Currently, an exhaustive search of all continuation records has to be done to
1476 determine whether to add a message id to a given record. This shouldn't be
1477 too bad except in extreme cases. I can't figure out a *simple* way of doing
1480 Old records should eventually get swept up by the exim_tidydb utility.
1483 hostlist list of hosts that this message could be sent to
1484 tpname name of the transport
1490 transport_update_waiting(host_item *hostlist, uschar *tpname)
1493 const uschar *prevname = US"";
1498 DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1500 /* Open the database for this transport */
1502 sprintf(CS buffer, "wait-%.200s", tpname);
1503 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1504 if (dbm_file == NULL) return;
1506 /* Scan the list of hosts for which this message is waiting, and ensure
1507 that the message id is in each host record. */
1509 for (host = hostlist; host!= NULL; host = host->next)
1511 BOOL already = FALSE;
1512 dbdata_wait *host_record;
1516 /* Skip if this is the same host as we just processed; otherwise remember
1517 the name for next time. */
1519 if (Ustrcmp(prevname, host->name) == 0) continue;
1520 prevname = host->name;
1522 /* Look up the host record; if there isn't one, make an empty one. */
1524 host_record = dbfn_read(dbm_file, host->name);
1525 if (host_record == NULL)
1527 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH);
1528 host_record->count = host_record->sequence = 0;
1531 /* Compute the current length */
1533 host_length = host_record->count * MESSAGE_ID_LENGTH;
1535 /* Search the record to see if the current message is already in it. */
1537 for (s = host_record->text; s < host_record->text + host_length;
1538 s += MESSAGE_ID_LENGTH)
1540 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1541 { already = TRUE; break; }
1544 /* If we haven't found this message in the main record, search any
1545 continuation records that exist. */
1547 for (i = host_record->sequence - 1; i >= 0 && !already; i--)
1550 sprintf(CS buffer, "%.200s:%d", host->name, i);
1551 cont = dbfn_read(dbm_file, buffer);
1554 int clen = cont->count * MESSAGE_ID_LENGTH;
1555 for (s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1557 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1558 { already = TRUE; break; }
1563 /* If this message is already in a record, no need to update. */
1567 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1572 /* If this record is full, write it out with a new name constructed
1573 from the sequence number, increase the sequence number, and empty
1576 if (host_record->count >= WAIT_NAME_MAX)
1578 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1579 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1580 host_record->sequence++;
1581 host_record->count = 0;
1585 /* If this record is not full, increase the size of the record to
1586 allow for one new message id. */
1591 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH);
1592 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1596 /* Now add the new name on the end */
1598 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1599 host_record->count++;
1600 host_length += MESSAGE_ID_LENGTH;
1602 /* Update the database */
1604 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1605 DEBUG(D_transport) debug_printf("added to list for %s\n", host->name);
1610 dbfn_close(dbm_file);
1616 /*************************************************
1617 * Test for waiting messages *
1618 *************************************************/
1620 /* This function is called by a remote transport which uses the previous
1621 function to remember which messages are waiting for which remote hosts. It's
1622 called after a successful delivery and its job is to check whether there is
1623 another message waiting for the same host. However, it doesn't do this if the
1624 current continue sequence is greater than the maximum supplied as an argument,
1625 or greater than the global connection_max_messages, which, if set, overrides.
1628 transport_name name of the transport
1629 hostname name of the host
1630 local_message_max maximum number of messages down one connection
1631 as set by the caller transport
1632 new_message_id set to the message id of a waiting message
1633 more set TRUE if there are yet more messages waiting
1634 oicf_func function to call to validate if it is ok to send
1635 to this message_id from the current instance.
1636 oicf_data opaque data for oicf_func
1638 Returns: TRUE if new_message_id set; FALSE otherwise
1641 typedef struct msgq_s
1643 uschar message_id [MESSAGE_ID_LENGTH + 1];
1648 transport_check_waiting(const uschar *transport_name, const uschar *hostname,
1649 int local_message_max, uschar *new_message_id, BOOL *more, oicf oicf_func, void *oicf_data)
1651 dbdata_wait *host_record;
1658 uschar spool_dir [PATH_MAX];
1659 uschar spool_file [PATH_MAX];
1660 struct stat statbuf;
1666 debug_printf("transport_check_waiting entered\n");
1667 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1668 continue_sequence, local_message_max, connection_max_messages);
1671 /* Do nothing if we have hit the maximum number that can be send down one
1674 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1675 if (local_message_max > 0 && continue_sequence >= local_message_max)
1678 debug_printf("max messages for one connection reached: returning\n");
1682 /* Open the waiting information database. */
1684 sprintf(CS buffer, "wait-%.200s", transport_name);
1685 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1686 if (dbm_file == NULL) return FALSE;
1688 /* See if there is a record for this host; if not, there's nothing to do. */
1690 if (!(host_record = dbfn_read(dbm_file, hostname)))
1692 dbfn_close(dbm_file);
1693 DEBUG(D_transport) debug_printf("no messages waiting for %s\n", hostname);
1697 /* If the data in the record looks corrupt, just log something and
1698 don't try to use it. */
1700 if (host_record->count > WAIT_NAME_MAX)
1702 dbfn_close(dbm_file);
1703 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1704 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1708 /* Scan the message ids in the record from the end towards the beginning,
1709 until one is found for which a spool file actually exists. If the record gets
1710 emptied, delete it and continue with any continuation records that may exist.
1713 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1714 but the 1 off will remain without it. This code now allows me to SKIP over
1715 a message I do not want to send out on this run. */
1717 sprintf(CS spool_dir, "%s/input/", spool_directory);
1719 host_length = host_record->count * MESSAGE_ID_LENGTH;
1725 int msgq_actual = 0;
1726 BOOL bFound = FALSE;
1727 BOOL bContinuation = FALSE;
1729 /* create an array to read entire message queue into memory for processing */
1731 msgq = (msgq_t*) malloc(sizeof(msgq_t) * host_record->count);
1732 msgq_count = host_record->count;
1733 msgq_actual = msgq_count;
1735 for (i = 0; i < host_record->count; ++i)
1737 msgq[i].bKeep = TRUE;
1739 Ustrncpy(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
1741 msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1744 /* first thing remove current message id if it exists */
1746 for (i = 0; i < msgq_count; ++i)
1747 if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1749 msgq[i].bKeep = FALSE;
1753 /* now find the next acceptable message_id */
1755 for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1757 if (split_spool_directory)
1758 sprintf(CS spool_file, "%s%c/%s-D",
1759 spool_dir, msgq[i].message_id[5], msgq[i].message_id);
1761 sprintf(CS spool_file, "%s%s-D", spool_dir, msgq[i].message_id);
1763 if (Ustat(spool_file, &statbuf) != 0)
1764 msgq[i].bKeep = FALSE;
1765 else if (!oicf_func || oicf_func(msgq[i].message_id, oicf_data))
1767 Ustrcpy(new_message_id, msgq[i].message_id);
1768 msgq[i].bKeep = FALSE;
1775 for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1779 /* reassemble the host record, based on removed message ids, from in
1782 if (msgq_actual <= 0)
1785 host_record->count = 0;
1789 host_length = msgq_actual * MESSAGE_ID_LENGTH;
1790 host_record->count = msgq_actual;
1792 if (msgq_actual < msgq_count)
1795 for (new_count = 0, i = 0; i < msgq_count; ++i)
1797 Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1798 msgq[i].message_id, MESSAGE_ID_LENGTH);
1800 host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1804 /* Jeremy: check for a continuation record, this code I do not know how to
1805 test but the code should work */
1807 while (host_length <= 0)
1810 dbdata_wait * newr = NULL;
1812 /* Search for a continuation */
1814 for (i = host_record->sequence - 1; i >= 0 && !newr; i--)
1816 sprintf(CS buffer, "%.200s:%d", hostname, i);
1817 newr = dbfn_read(dbm_file, buffer);
1820 /* If no continuation, delete the current and break the loop */
1824 dbfn_delete(dbm_file, hostname);
1828 /* Else replace the current with the continuation */
1830 dbfn_delete(dbm_file, buffer);
1832 host_length = host_record->count * MESSAGE_ID_LENGTH;
1834 bContinuation = TRUE;
1837 if (bFound) /* Usual exit from main loop */
1843 /* If host_length <= 0 we have emptied a record and not found a good message,
1844 and there are no continuation records. Otherwise there is a continuation
1845 record to process. */
1847 if (host_length <= 0)
1849 dbfn_close(dbm_file);
1850 DEBUG(D_transport) debug_printf("waiting messages already delivered\n");
1854 /* we were not able to find an acceptable message, nor was there a
1855 * continuation record. So bug out, outer logic will clean this up.
1860 Ustrcpy(new_message_id, message_id);
1861 dbfn_close(dbm_file);
1866 } /* we need to process a continuation record */
1868 /* Control gets here when an existing message has been encountered; its
1869 id is in new_message_id, and host_length is the revised length of the
1870 host record. If it is zero, the record has been removed. Update the
1871 record if required, close the database, and return TRUE. */
1873 if (host_length > 0)
1875 host_record->count = host_length/MESSAGE_ID_LENGTH;
1877 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1881 dbfn_close(dbm_file);
1885 /*************************************************
1886 * Deliver waiting message down same socket *
1887 *************************************************/
1889 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1890 get a clean delivery process, and to regain root privilege in cases where it
1891 has been given away.
1894 transport_name to pass to the new process
1897 id the new message to process
1898 socket_fd the connected socket
1900 Returns: FALSE if fork fails; TRUE otherwise
1904 transport_pass_socket(const uschar *transport_name, const uschar *hostname,
1905 const uschar *hostaddress, uschar *id, int socket_fd)
1910 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
1912 if ((pid = fork()) == 0)
1915 const uschar **argv;
1917 /* Disconnect entirely from the parent process. If we are running in the
1918 test harness, wait for a bit to allow the previous process time to finish,
1919 write the log, etc., so that the output is always in the same order for
1920 automatic comparison. */
1922 if ((pid = fork()) != 0) _exit(EXIT_SUCCESS);
1923 if (running_in_test_harness) sleep(1);
1925 /* Set up the calling arguments; use the standard function for the basics,
1926 but we have a number of extras that may be added. */
1928 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1930 /* Call with the dsn flag */
1931 if (smtp_use_dsn) argv[i++] = US"-MCD";
1933 if (smtp_authenticated) argv[i++] = US"-MCA";
1936 if (tls_offered) argv[i++] = US"-MCT";
1939 if (smtp_use_size) argv[i++] = US"-MCS";
1940 if (smtp_use_pipelining) argv[i++] = US"-MCP";
1942 if (queue_run_pid != (pid_t)0)
1944 argv[i++] = US"-MCQ";
1945 argv[i++] = string_sprintf("%d", queue_run_pid);
1946 argv[i++] = string_sprintf("%d", queue_run_pipe);
1949 argv[i++] = US"-MC";
1950 argv[i++] = US transport_name;
1951 argv[i++] = US hostname;
1952 argv[i++] = US hostaddress;
1953 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1957 /* Arrange for the channel to be on stdin. */
1961 (void)dup2(socket_fd, 0);
1962 (void)close(socket_fd);
1965 DEBUG(D_exec) debug_print_argv(argv);
1966 exim_nullstd(); /* Ensure std{out,err} exist */
1967 execv(CS argv[0], (char *const *)argv);
1969 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1970 _exit(errno); /* Note: must be _exit(), NOT exit() */
1973 /* If the process creation succeeded, wait for the first-level child, which
1974 immediately exits, leaving the second level process entirely disconnected from
1980 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
1981 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded\n");
1986 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
1994 /*************************************************
1995 * Set up direct (non-shell) command *
1996 *************************************************/
1998 /* This function is called when a command line is to be parsed and executed
1999 directly, without the use of /bin/sh. It is called by the pipe transport,
2000 the queryprogram router, and also from the main delivery code when setting up a
2001 transport filter process. The code for ETRN also makes use of this; in that
2002 case, no addresses are passed.
2005 argvptr pointer to anchor for argv vector
2006 cmd points to the command string (modified IN PLACE)
2007 expand_arguments true if expansion is to occur
2008 expand_failed error value to set if expansion fails; not relevant if
2010 addr chain of addresses, or NULL
2011 etext text for use in error messages
2012 errptr where to put error message if addr is NULL;
2013 otherwise it is put in the first address
2015 Returns: TRUE if all went well; otherwise an error will be
2016 set in the first address and FALSE returned
2020 transport_set_up_command(const uschar ***argvptr, uschar *cmd,
2021 BOOL expand_arguments, int expand_failed, address_item *addr,
2022 uschar *etext, uschar **errptr)
2025 const uschar **argv;
2027 int address_count = 0;
2031 /* Get store in which to build an argument list. Count the number of addresses
2032 supplied, and allow for that many arguments, plus an additional 60, which
2033 should be enough for anybody. Multiple addresses happen only when the local
2034 delivery batch option is set. */
2036 for (ad = addr; ad != NULL; ad = ad->next) address_count++;
2037 max_args = address_count + 60;
2038 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *));
2040 /* Split the command up into arguments terminated by white space. Lose
2041 trailing space at the start and end. Double-quoted arguments can contain \\ and
2042 \" escapes and so can be handled by the standard function; single-quoted
2043 arguments are verbatim. Copy each argument into a new string. */
2046 while (isspace(*s)) s++;
2048 while (*s != 0 && argcount < max_args)
2053 while (*ss != 0 && *ss != '\'') ss++;
2054 argv[argcount++] = ss = store_get(ss - s++);
2055 while (*s != 0 && *s != '\'') *ss++ = *s++;
2059 else argv[argcount++] = string_copy(string_dequote(CUSS &s));
2060 while (isspace(*s)) s++;
2063 argv[argcount] = (uschar *)0;
2065 /* If *s != 0 we have run out of argument slots. */
2069 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2073 addr->transport_return = FAIL;
2074 addr->message = msg;
2080 /* Expand each individual argument if required. Expansion happens for pipes set
2081 up in filter files and with directly-supplied commands. It does not happen if
2082 the pipe comes from a traditional .forward file. A failing expansion is a big
2083 disaster if the command came from Exim's configuration; if it came from a user
2084 it is just a normal failure. The expand_failed value is used as the error value
2085 to cater for these two cases.
2087 An argument consisting just of the text "$pipe_addresses" is treated specially.
2088 It is not passed to the general expansion function. Instead, it is replaced by
2089 a number of arguments, one for each address. This avoids problems with shell
2090 metacharacters and spaces in addresses.
2092 If the parent of the top address has an original part of "system-filter", this
2093 pipe was set up by the system filter, and we can permit the expansion of
2098 debug_printf("direct command:\n");
2099 for (i = 0; argv[i] != (uschar *)0; i++)
2100 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2103 if (expand_arguments)
2105 BOOL allow_dollar_recipients = addr != NULL &&
2106 addr->parent != NULL &&
2107 Ustrcmp(addr->parent->address, "system-filter") == 0;
2109 for (i = 0; argv[i] != (uschar *)0; i++)
2112 /* Handle special fudge for passing an address list */
2115 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2116 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2120 if (argcount + address_count - 1 > max_args)
2122 addr->transport_return = FAIL;
2123 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2124 "in %s", cmd, etext);
2128 additional = address_count - 1;
2130 memmove(argv + i + 1 + additional, argv + i + 1,
2131 (argcount - i)*sizeof(uschar *));
2133 for (ad = addr; ad != NULL; ad = ad->next) {
2134 argv[i++] = ad->address;
2138 /* Subtract one since we replace $pipe_addresses */
2143 /* Handle special case of $address_pipe when af_force_command is set */
2145 else if (addr != NULL && testflag(addr,af_force_command) &&
2146 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2147 Ustrcmp(argv[i], "${address_pipe}") == 0))
2150 int address_pipe_argcount = 0;
2151 int address_pipe_max_args;
2152 uschar **address_pipe_argv;
2154 /* We can never have more then the argv we will be loading into */
2155 address_pipe_max_args = max_args - argcount + 1;
2158 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2160 /* We allocate an additional for (uschar *)0 */
2161 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *));
2163 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2164 s = expand_string(addr->local_part + 1);
2166 if (s == NULL || *s == '\0')
2168 addr->transport_return = FAIL;
2169 addr->message = string_sprintf("Expansion of \"%s\" "
2170 "from command \"%s\" in %s failed: %s",
2171 (addr->local_part + 1), cmd, etext, expand_string_message);
2175 while (isspace(*s)) s++; /* strip leading space */
2177 while (*s != 0 && address_pipe_argcount < address_pipe_max_args)
2182 while (*ss != 0 && *ss != '\'') ss++;
2183 address_pipe_argv[address_pipe_argcount++] = ss = store_get(ss - s++);
2184 while (*s != 0 && *s != '\'') *ss++ = *s++;
2188 else address_pipe_argv[address_pipe_argcount++] =
2189 string_copy(string_dequote(CUSS &s));
2190 while (isspace(*s)) s++; /* strip space after arg */
2193 address_pipe_argv[address_pipe_argcount] = (uschar *)0;
2195 /* If *s != 0 we have run out of argument slots. */
2198 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2199 "\"%s\" in %s", addr->local_part + 1, etext);
2202 addr->transport_return = FAIL;
2203 addr->message = msg;
2209 /* address_pipe_argcount - 1
2210 * because we are replacing $address_pipe in the argument list
2211 * with the first thing it expands to */
2212 if (argcount + address_pipe_argcount - 1 > max_args)
2214 addr->transport_return = FAIL;
2215 addr->message = string_sprintf("Too many arguments to command "
2216 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2220 /* If we are not just able to replace the slot that contained
2221 * $address_pipe (address_pipe_argcount == 1)
2222 * We have to move the existing argv by address_pipe_argcount - 1
2223 * Visually if address_pipe_argcount == 2:
2224 * [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2225 * [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0]
2227 if (address_pipe_argcount > 1)
2229 /* current position + additonal args */
2230 argv + i + address_pipe_argcount,
2231 /* current position + 1 (for the (uschar *)0 at the end) */
2233 /* -1 for the (uschar *)0 at the end)*/
2234 (argcount - i)*sizeof(uschar *)
2237 /* Now we fill in the slots we just moved argv out of
2238 * [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0]
2240 for (address_pipe_i = 0;
2241 address_pipe_argv[address_pipe_i] != (uschar *)0;
2244 argv[i++] = address_pipe_argv[address_pipe_i];
2248 /* Subtract one since we replace $address_pipe */
2253 /* Handle normal expansion string */
2257 const uschar *expanded_arg;
2258 enable_dollar_recipients = allow_dollar_recipients;
2259 expanded_arg = expand_cstring(argv[i]);
2260 enable_dollar_recipients = FALSE;
2262 if (expanded_arg == NULL)
2264 uschar *msg = string_sprintf("Expansion of \"%s\" "
2265 "from command \"%s\" in %s failed: %s",
2266 argv[i], cmd, etext, expand_string_message);
2269 addr->transport_return = expand_failed;
2270 addr->message = msg;
2275 argv[i] = expanded_arg;
2281 debug_printf("direct command after expansion:\n");
2282 for (i = 0; argv[i] != (uschar *)0; i++)
2283 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2292 /* End of transport.c */