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