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