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