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