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