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