68f8d1f583da8d878bd689cbc6f2700ceb9ce850
[users/jgh/exim.git] / src / src / transports / autoreply.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
7
8
9 #include "../exim.h"
10 #include "autoreply.h"
11
12
13
14 /* Options specific to the autoreply transport. They must be in alphabetic
15 order (note that "_" comes before the lower case letters). Those starting
16 with "*" are not settable by the user but are used by the option-reading
17 software for alternative value types. Some options are publicly visible and so
18 are stored in the driver instance block. These are flagged with opt_public. */
19
20 optionlist autoreply_transport_options[] = {
21   { "bcc",               opt_stringptr,
22       (void *)offsetof(autoreply_transport_options_block, bcc) },
23   { "cc",                opt_stringptr,
24       (void *)offsetof(autoreply_transport_options_block, cc) },
25   { "file",              opt_stringptr,
26       (void *)offsetof(autoreply_transport_options_block, file) },
27   { "file_expand",     opt_bool,
28       (void *)offsetof(autoreply_transport_options_block, file_expand) },
29   { "file_optional",     opt_bool,
30       (void *)offsetof(autoreply_transport_options_block, file_optional) },
31   { "from",              opt_stringptr,
32       (void *)offsetof(autoreply_transport_options_block, from) },
33   { "headers",           opt_stringptr,
34       (void *)offsetof(autoreply_transport_options_block, headers) },
35   { "log",               opt_stringptr,
36       (void *)offsetof(autoreply_transport_options_block, logfile) },
37   { "mode",              opt_octint,
38       (void *)offsetof(autoreply_transport_options_block, mode) },
39   { "never_mail",        opt_stringptr,
40       (void *)offsetof(autoreply_transport_options_block, never_mail) },
41   { "once",              opt_stringptr,
42       (void *)offsetof(autoreply_transport_options_block, oncelog) },
43   { "once_file_size",    opt_int,
44       (void *)offsetof(autoreply_transport_options_block, once_file_size) },
45   { "once_repeat",       opt_stringptr,
46       (void *)offsetof(autoreply_transport_options_block, once_repeat) },
47   { "reply_to",          opt_stringptr,
48       (void *)offsetof(autoreply_transport_options_block, reply_to) },
49   { "return_message",    opt_bool,
50       (void *)offsetof(autoreply_transport_options_block, return_message) },
51   { "subject",           opt_stringptr,
52       (void *)offsetof(autoreply_transport_options_block, subject) },
53   { "text",              opt_stringptr,
54       (void *)offsetof(autoreply_transport_options_block, text) },
55   { "to",                opt_stringptr,
56       (void *)offsetof(autoreply_transport_options_block, to) },
57 };
58
59 /* Size of the options list. An extern variable has to be used so that its
60 address can appear in the tables drtables.c. */
61
62 int autoreply_transport_options_count =
63   sizeof(autoreply_transport_options)/sizeof(optionlist);
64
65
66 #ifdef MACRO_PREDEF
67
68 /* Dummy values */
69 autoreply_transport_options_block autoreply_transport_option_defaults = {0};
70 void autoreply_transport_init(transport_instance *tblock) {}
71 BOOL autoreply_transport_entry(transport_instance *tblock, address_item *addr) {return FALSE;}
72
73 #else   /*!MACRO_PREDEF*/
74
75
76 /* Default private options block for the autoreply transport. */
77
78 autoreply_transport_options_block autoreply_transport_option_defaults = {
79   NULL,           /* from */
80   NULL,           /* reply_to */
81   NULL,           /* to */
82   NULL,           /* cc */
83   NULL,           /* bcc */
84   NULL,           /* subject */
85   NULL,           /* headers */
86   NULL,           /* text */
87   NULL,           /* file */
88   NULL,           /* logfile */
89   NULL,           /* oncelog */
90   NULL,           /* once_repeat */
91   NULL,           /* never_mail */
92   0600,           /* mode */
93   0,              /* once_file_size */
94   FALSE,          /* file_expand */
95   FALSE,          /* file_optional */
96   FALSE           /* return message */
97 };
98
99
100
101 /* Type of text for the checkexpand() function */
102
103 enum { cke_text, cke_hdr, cke_file };
104
105
106
107 /*************************************************
108 *          Initialization entry point            *
109 *************************************************/
110
111 /* Called for each instance, after its options have been read, to
112 enable consistency checks to be done, or anything else that needs
113 to be set up. */
114
115 void
116 autoreply_transport_init(transport_instance *tblock)
117 {
118 /*
119 autoreply_transport_options_block *ob =
120   (autoreply_transport_options_block *)(tblock->options_block);
121 */
122
123 /* If a fixed uid field is set, then a gid field must also be set. */
124
125 if (tblock->uid_set && !tblock->gid_set && tblock->expand_gid == NULL)
126   log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
127     "user set without group for the %s transport", tblock->name);
128 }
129
130
131
132
133 /*************************************************
134 *          Expand string and check               *
135 *************************************************/
136
137 /* If the expansion fails, the error is set up in the address. Expanded
138 strings must be checked to ensure they contain only printing characters
139 and white space. If not, the function fails.
140
141 Arguments:
142    s         string to expand
143    addr      address that is being worked on
144    name      transport name, for error text
145    type      type, for checking content:
146                cke_text => no check
147                cke_hdr  => header, allow \n + whitespace
148                cke_file => file name, no non-printers allowed
149
150 Returns:     expanded string if expansion succeeds;
151              NULL otherwise
152 */
153
154 static uschar *
155 checkexpand(uschar *s, address_item *addr, uschar *name, int type)
156 {
157 uschar *ss = expand_string(s);
158
159 if (ss == NULL)
160   {
161   addr->transport_return = FAIL;
162   addr->message = string_sprintf("Expansion of \"%s\" failed in %s transport: "
163     "%s", s, name, expand_string_message);
164   return NULL;
165   }
166
167 if (type != cke_text) for (uschar * t = ss; *t != 0; t++)
168   {
169   int c = *t;
170   const uschar * sp;
171   if (mac_isprint(c)) continue;
172   if (type == cke_hdr && c == '\n' && (t[1] == ' ' || t[1] == '\t')) continue;
173   sp = string_printing(s);
174   addr->transport_return = FAIL;
175   addr->message = string_sprintf("Expansion of \"%s\" in %s transport "
176     "contains non-printing character %d", sp, name, c);
177   return NULL;
178   }
179
180 return ss;
181 }
182
183
184
185
186 /*************************************************
187 *          Check a header line for never_mail    *
188 *************************************************/
189
190 /* This is called to check to, cc, and bcc for addresses in the never_mail
191 list. Any that are found are removed.
192
193 Arguments:
194   listptr     points to the list of addresses
195   never_mail  an address list, already expanded
196
197 Returns:      nothing
198 */
199
200 static void
201 check_never_mail(uschar **listptr, const uschar *never_mail)
202 {
203 uschar *s = *listptr;
204
205 while (*s != 0)
206   {
207   uschar *error, *next;
208   uschar *e = parse_find_address_end(s, FALSE);
209   int terminator = *e;
210   int start, end, domain, rc;
211
212   /* Temporarily terminate the string at the address end while extracting
213   the operative address within. */
214
215   *e = 0;
216   next = parse_extract_address(s, &error, &start, &end, &domain, FALSE);
217   *e = terminator;
218
219   /* If there is some kind of syntax error, just give up on this header
220   line. */
221
222   if (next == NULL) break;
223
224   /* See if the address is on the never_mail list */
225
226   rc = match_address_list(next,         /* address to check */
227                           TRUE,         /* start caseless */
228                           FALSE,        /* don't expand the list */
229                           &never_mail,  /* the list */
230                           NULL,         /* no caching */
231                           -1,           /* no expand setup */
232                           0,            /* separator from list */
233                           NULL);        /* no lookup value return */
234
235   if (rc == OK)                         /* Remove this address */
236     {
237     DEBUG(D_transport)
238       debug_printf("discarding recipient %s (matched never_mail)\n", next);
239     if (terminator == ',') e++;
240     memmove(s, e, Ustrlen(e) + 1);
241     }
242   else                                  /* Skip over this address */
243     {
244     s = e;
245     if (terminator == ',') s++;
246     }
247   }
248
249 /* Check to see if we removed the last address, leaving a terminating comma
250 that needs to be removed */
251
252 s = *listptr + Ustrlen(*listptr);
253 while (s > *listptr && (isspace(s[-1]) || s[-1] == ',')) s--;
254 *s = 0;
255
256 /* Check to see if there any addresses left; if not, set NULL */
257
258 s = *listptr;
259 while (s != 0 && isspace(*s)) s++;
260 if (*s == 0) *listptr = NULL;
261 }
262
263
264
265 /*************************************************
266 *              Main entry point                  *
267 *************************************************/
268
269 /* See local README for interface details. This transport always returns
270 FALSE, indicating that the top address has the status for all - though in fact
271 this transport can handle only one address at at time anyway. */
272
273 BOOL
274 autoreply_transport_entry(
275   transport_instance *tblock,      /* data for this instantiation */
276   address_item *addr)              /* address we are working on */
277 {
278 int fd, pid, rc;
279 int cache_fd = -1;
280 int cache_size = 0;
281 int add_size = 0;
282 EXIM_DB *dbm_file = NULL;
283 BOOL file_expand, return_message;
284 uschar *from, *reply_to, *to, *cc, *bcc, *subject, *headers, *text, *file;
285 uschar *logfile, *oncelog;
286 uschar *cache_buff = NULL;
287 uschar *cache_time = NULL;
288 uschar *message_id = NULL;
289 header_line *h;
290 time_t now = time(NULL);
291 time_t once_repeat_sec = 0;
292 FILE *fp;
293 FILE *ff = NULL;
294
295 autoreply_transport_options_block *ob =
296   (autoreply_transport_options_block *)(tblock->options_block);
297
298 DEBUG(D_transport) debug_printf("%s transport entered\n", tblock->name);
299
300 /* Set up for the good case */
301
302 addr->transport_return = OK;
303 addr->basic_errno = 0;
304
305 /* If the address is pointing to a reply block, then take all the data
306 from that block. It has typically been set up by a mail filter processing
307 router. Otherwise, the data must be supplied by this transport, and
308 it has to be expanded here. */
309
310 if (addr->reply != NULL)
311   {
312   DEBUG(D_transport) debug_printf("taking data from address\n");
313   from = addr->reply->from;
314   reply_to = addr->reply->reply_to;
315   to = addr->reply->to;
316   cc = addr->reply->cc;
317   bcc = addr->reply->bcc;
318   subject = addr->reply->subject;
319   headers = addr->reply->headers;
320   text = addr->reply->text;
321   file = addr->reply->file;
322   logfile = addr->reply->logfile;
323   oncelog = addr->reply->oncelog;
324   once_repeat_sec = addr->reply->once_repeat;
325   file_expand = addr->reply->file_expand;
326   expand_forbid = addr->reply->expand_forbid;
327   return_message = addr->reply->return_message;
328   }
329 else
330   {
331   uschar *oncerepeat = ob->once_repeat;
332
333   DEBUG(D_transport) debug_printf("taking data from transport\n");
334   from = ob->from;
335   reply_to = ob->reply_to;
336   to = ob->to;
337   cc = ob->cc;
338   bcc = ob->bcc;
339   subject = ob->subject;
340   headers = ob->headers;
341   text = ob->text;
342   file = ob->file;
343   logfile = ob->logfile;
344   oncelog = ob->oncelog;
345   file_expand = ob->file_expand;
346   return_message = ob->return_message;
347
348   if (  from && !(from = checkexpand(from, addr, tblock->name, cke_hdr))
349      || reply_to && !(reply_to = checkexpand(reply_to, addr, tblock->name, cke_hdr))
350      || to && !(to = checkexpand(to, addr, tblock->name, cke_hdr))
351      || cc && !(cc = checkexpand(cc, addr, tblock->name, cke_hdr))
352      || bcc && !(bcc = checkexpand(bcc, addr, tblock->name, cke_hdr))
353      || subject && !(subject = checkexpand(subject, addr, tblock->name, cke_hdr))
354      || headers && !(headers = checkexpand(headers, addr, tblock->name, cke_text))
355      || text && !(text = checkexpand(text, addr, tblock->name, cke_text))
356      || file && !(file = checkexpand(file, addr, tblock->name, cke_file))
357      || logfile && !(logfile = checkexpand(logfile, addr, tblock->name, cke_file))
358      || oncelog && !(oncelog = checkexpand(oncelog, addr, tblock->name, cke_file))
359      || oncerepeat && !(oncerepeat = checkexpand(oncerepeat, addr, tblock->name, cke_file))
360      )
361     return FALSE;
362
363   if (oncerepeat)
364     {
365     once_repeat_sec = readconf_readtime(oncerepeat, 0, FALSE);
366     if (once_repeat_sec < 0)
367       {
368       addr->transport_return = FAIL;
369       addr->message = string_sprintf("Invalid time value \"%s\" for "
370         "\"once_repeat\" in %s transport", oncerepeat, tblock->name);
371       return FALSE;
372       }
373     }
374   }
375
376 /* If the never_mail option is set, we have to scan all the recipients and
377 remove those that match. */
378
379 if (ob->never_mail)
380   {
381   const uschar *never_mail = expand_string(ob->never_mail);
382
383   if (!never_mail)
384     {
385     addr->transport_return = FAIL;
386     addr->message = string_sprintf("Failed to expand \"%s\" for "
387       "\"never_mail\" in %s transport", ob->never_mail, tblock->name);
388     return FALSE;
389     }
390
391   if (to) check_never_mail(&to, never_mail);
392   if (cc) check_never_mail(&cc, never_mail);
393   if (bcc) check_never_mail(&bcc, never_mail);
394
395   if (!to && !cc && !bcc)
396     {
397     DEBUG(D_transport)
398       debug_printf("*** all recipients removed by never_mail\n");
399     return OK;
400     }
401   }
402
403 /* If the -N option is set, can't do any more. */
404
405 if (f.dont_deliver)
406   {
407   DEBUG(D_transport)
408     debug_printf("*** delivery by %s transport bypassed by -N option\n",
409       tblock->name);
410   return FALSE;
411   }
412
413
414 /* If the oncelog field is set, we send want to send only one message to the
415 given recipient(s). This works only on the "To" field. If there is no "To"
416 field, the message is always sent. If the To: field contains more than one
417 recipient, the effect might not be quite as envisaged. If once_file_size is
418 set, instead of a dbm file, we use a regular file containing a circular buffer
419 recipient cache. */
420
421 if (oncelog && *oncelog != 0 && to)
422   {
423   time_t then = 0;
424
425   /* Handle fixed-size cache file. */
426
427   if (ob->once_file_size > 0)
428     {
429     uschar * nextp;
430     struct stat statbuf;
431     cache_fd = Uopen(oncelog, O_CREAT|O_RDWR, ob->mode);
432
433     if (cache_fd < 0 || fstat(cache_fd, &statbuf) != 0)
434       {
435       addr->transport_return = DEFER;
436       addr->basic_errno = errno;
437       addr->message = string_sprintf("Failed to %s \"once\" file %s when "
438         "sending message from %s transport: %s",
439         cache_fd < 0 ? "open" : "stat", oncelog, tblock->name, strerror(errno));
440       goto END_OFF;
441       }
442
443     /* Get store in the temporary pool and read the entire file into it. We get
444     an amount of store that is big enough to add the new entry on the end if we
445     need to do that. */
446
447     cache_size = statbuf.st_size;
448     add_size = sizeof(time_t) + Ustrlen(to) + 1;
449     cache_buff = store_get(cache_size + add_size, is_tainted(oncelog));
450
451     if (read(cache_fd, cache_buff, cache_size) != cache_size)
452       {
453       addr->transport_return = DEFER;
454       addr->basic_errno = errno;
455       addr->message = US"error while reading \"once\" file";
456       goto END_OFF;
457       }
458
459     DEBUG(D_transport) debug_printf("%d bytes read from %s\n", cache_size, oncelog);
460
461     /* Scan the data for this recipient. Each entry in the file starts with
462     a time_t sized time value, followed by the address, followed by a binary
463     zero. If we find a match, put the time into "then", and the place where it
464     was found into "cache_time". Otherwise, "then" is left at zero. */
465
466     for (uschar * p = cache_buff; p < cache_buff + cache_size; p = nextp)
467       {
468       uschar *s = p + sizeof(time_t);
469       nextp = s + Ustrlen(s) + 1;
470       if (Ustrcmp(to, s) == 0)
471         {
472         memcpy(&then, p, sizeof(time_t));
473         cache_time = p;
474         break;
475         }
476       }
477     }
478
479   /* Use a DBM file for the list of previous recipients. */
480
481   else
482     {
483     EXIM_DATUM key_datum, result_datum;
484     uschar * dirname = string_copy(oncelog);
485     uschar * s;
486
487     if ((s = Ustrrchr(dirname, '/'))) *s = '\0';
488     EXIM_DBOPEN(oncelog, dirname, O_RDWR|O_CREAT, ob->mode, &dbm_file);
489     if (!dbm_file)
490       {
491       addr->transport_return = DEFER;
492       addr->basic_errno = errno;
493       addr->message = string_sprintf("Failed to open %s file %s when sending "
494         "message from %s transport: %s", EXIM_DBTYPE, oncelog, tblock->name,
495         strerror(errno));
496       goto END_OFF;
497       }
498
499     EXIM_DATUM_INIT(key_datum);        /* Some DBM libraries need datums */
500     EXIM_DATUM_INIT(result_datum);     /* to be cleared */
501     EXIM_DATUM_DATA(key_datum) = CS to;
502     EXIM_DATUM_SIZE(key_datum) = Ustrlen(to) + 1;
503
504     if (EXIM_DBGET(dbm_file, key_datum, result_datum))
505       {
506       /* If the datum size is that of a binary time, we are in the new world
507       where messages are sent periodically. Otherwise the file is an old one,
508       where the datum was filled with a tod_log time, which is assumed to be
509       different in size. For that, only one message is ever sent. This change
510       introduced at Exim 3.00. In a couple of years' time the test on the size
511       can be abolished. */
512
513       if (EXIM_DATUM_SIZE(result_datum) == sizeof(time_t))
514         memcpy(&then, EXIM_DATUM_DATA(result_datum), sizeof(time_t));
515       else
516         then = now;
517       }
518     }
519
520   /* Either "then" is set zero, if no message has yet been sent, or it
521   is set to the time of the last sending. */
522
523   if (then != 0 && (once_repeat_sec <= 0 || now - then < once_repeat_sec))
524     {
525     int log_fd;
526     DEBUG(D_transport) debug_printf("message previously sent to %s%s\n", to,
527       (once_repeat_sec > 0)? " and repeat time not reached" : "");
528     log_fd = logfile ? Uopen(logfile, O_WRONLY|O_APPEND|O_CREAT, ob->mode) : -1;
529     if (log_fd >= 0)
530       {
531       uschar *ptr = log_buffer;
532       sprintf(CS ptr, "%s\n  previously sent to %.200s\n", tod_stamp(tod_log), to);
533       while(*ptr) ptr++;
534       if(write(log_fd, log_buffer, ptr - log_buffer) != ptr-log_buffer
535         || close(log_fd))
536         DEBUG(D_transport) debug_printf("Problem writing log file %s for %s "
537           "transport\n", logfile, tblock->name);
538       }
539     goto END_OFF;
540     }
541
542   DEBUG(D_transport) debug_printf("%s %s\n", (then <= 0)?
543     "no previous message sent to" : "repeat time reached for", to);
544   }
545
546 /* We are going to send a message. Ensure any requested file is available. */
547
548 if (file && !(ff = Ufopen(file, "rb")) && !ob->file_optional)
549   {
550   addr->transport_return = DEFER;
551   addr->basic_errno = errno;
552   addr->message = string_sprintf("Failed to open file %s when sending "
553     "message from %s transport: %s", file, tblock->name, strerror(errno));
554   return FALSE;
555   }
556
557 /* Make a subprocess to send the message */
558
559 pid = child_open_exim(&fd);
560
561 /* Creation of child failed; defer this delivery. */
562
563 if (pid < 0)
564   {
565   addr->transport_return = DEFER;
566   addr->basic_errno = errno;
567   addr->message = string_sprintf("Failed to create child process to send "
568     "message from %s transport: %s", tblock->name, strerror(errno));
569   DEBUG(D_transport) debug_printf("%s\n", addr->message);
570   if (dbm_file) EXIM_DBCLOSE(dbm_file);
571   return FALSE;
572   }
573
574 /* Create the message to be sent - recipients are taken from the headers,
575 as the -t option is used. The "headers" stuff *must* be last in case there
576 are newlines in it which might, if placed earlier, screw up other headers. */
577
578 fp = fdopen(fd, "wb");
579
580 if (from) fprintf(fp, "From: %s\n", from);
581 if (reply_to) fprintf(fp, "Reply-To: %s\n", reply_to);
582 if (to) fprintf(fp, "To: %s\n", to);
583 if (cc) fprintf(fp, "Cc: %s\n", cc);
584 if (bcc) fprintf(fp, "Bcc: %s\n", bcc);
585 if (subject) fprintf(fp, "Subject: %s\n", subject);
586
587 /* Generate In-Reply-To from the message_id header; there should
588 always be one, but code defensively. */
589
590 for (h = header_list; h; h = h->next)
591   if (h->type == htype_id) break;
592
593 if (h)
594   {
595   message_id = Ustrchr(h->text, ':') + 1;
596   while (isspace(*message_id)) message_id++;
597   fprintf(fp, "In-Reply-To: %s", message_id);
598   }
599
600 moan_write_references(fp, message_id);
601
602 /* Add an Auto-Submitted: header */
603
604 fprintf(fp, "Auto-Submitted: auto-replied\n");
605
606 /* Add any specially requested headers */
607
608 if (headers) fprintf(fp, "%s\n", headers);
609 fprintf(fp, "\n");
610
611 if (text)
612   {
613   fprintf(fp, "%s", CS text);
614   if (text[Ustrlen(text)-1] != '\n') fprintf(fp, "\n");
615   }
616
617 if (ff)
618   {
619   while (Ufgets(big_buffer, big_buffer_size, ff) != NULL)
620     {
621     if (file_expand)
622       {
623       uschar *s = expand_string(big_buffer);
624       DEBUG(D_transport)
625         {
626         if (!s)
627           debug_printf("error while expanding line from file:\n  %s\n  %s\n",
628             big_buffer, expand_string_message);
629         }
630       fprintf(fp, "%s", s ? CS s : CS big_buffer);
631       }
632     else fprintf(fp, "%s", CS big_buffer);
633     }
634   (void) fclose(ff);
635   }
636
637 /* Copy the original message if required, observing the return size
638 limit if we are returning the body. */
639
640 if (return_message)
641   {
642   uschar *rubric = (tblock->headers_only)?
643     US"------ This is a copy of the message's header lines.\n"
644     : (tblock->body_only)?
645     US"------ This is a copy of the body of the message, without the headers.\n"
646     :
647     US"------ This is a copy of the message, including all the headers.\n";
648   transport_ctx tctx = {
649     .u = {.fd = fileno(fp)},
650     .tblock = tblock,
651     .addr = addr,
652     .check_string = NULL,
653     .escape_string =  NULL,
654     .options = (tblock->body_only ? topt_no_headers : 0)
655         | (tblock->headers_only ? topt_no_body : 0)
656         | (tblock->return_path_add ? topt_add_return_path : 0)
657         | (tblock->delivery_date_add ? topt_add_delivery_date : 0)
658         | (tblock->envelope_to_add ? topt_add_envelope_to : 0)
659         | topt_not_socket
660   };
661
662   if (bounce_return_size_limit > 0 && !tblock->headers_only)
663     {
664     struct stat statbuf;
665     int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
666       DELIVER_IN_BUFFER_SIZE;
667     if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
668       {
669       fprintf(fp, "\n%s"
670 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
671 "------ %d or so are included here.\n\n", rubric, statbuf.st_size,
672         (max/1000)*1000);
673       }
674     else fprintf(fp, "\n%s\n", rubric);
675     }
676   else fprintf(fp, "\n%s\n", rubric);
677
678   fflush(fp);
679   transport_count = 0;
680   transport_write_message(&tctx, bounce_return_size_limit);
681   }
682
683 /* End the message and wait for the child process to end; no timeout. */
684
685 (void)fclose(fp);
686 rc = child_close(pid, 0);
687
688 /* Update the "sent to" log whatever the yield. This errs on the side of
689 missing out a message rather than risking sending more than one. We either have
690 cache_fd set to a fixed size, circular buffer file, or dbm_file set to an open
691 DBM file (or neither, if "once" is not set). */
692
693 /* Update fixed-size cache file. If cache_time is set, we found a previous
694 entry; that is the spot into which to put the current time. Otherwise we have
695 to add a new record; remove the first one in the file if the file is too big.
696 We always rewrite the entire file in a single write operation. This is
697 (hopefully) going to be the safest thing because there is no interlocking
698 between multiple simultaneous deliveries. */
699
700 if (cache_fd >= 0)
701   {
702   uschar *from = cache_buff;
703   int size = cache_size;
704
705   if (lseek(cache_fd, 0, SEEK_SET) == 0)
706     {
707     if (!cache_time)
708       {
709       cache_time = from + size;
710       memcpy(cache_time + sizeof(time_t), to, add_size - sizeof(time_t));
711       size += add_size;
712
713       if (cache_size > 0 && size > ob->once_file_size)
714         {
715         from += sizeof(time_t) + Ustrlen(from + sizeof(time_t)) + 1;
716         size -= (from - cache_buff);
717         }
718       }
719
720     memcpy(cache_time, &now, sizeof(time_t));
721     if(write(cache_fd, from, size) != size)
722       DEBUG(D_transport) debug_printf("Problem writing cache file %s for %s "
723         "transport\n", oncelog, tblock->name);
724     }
725   }
726
727 /* Update DBM file */
728
729 else if (dbm_file)
730   {
731   EXIM_DATUM key_datum, value_datum;
732   EXIM_DATUM_INIT(key_datum);          /* Some DBM libraries need to have */
733   EXIM_DATUM_INIT(value_datum);        /* cleared datums. */
734   EXIM_DATUM_DATA(key_datum) = CS to;
735   EXIM_DATUM_SIZE(key_datum) = Ustrlen(to) + 1;
736
737   /* Many OS define the datum value, sensibly, as a void *. However, there
738   are some which still have char *. By casting this address to a char * we
739   can avoid warning messages from the char * systems. */
740
741   EXIM_DATUM_DATA(value_datum) = CS (&now);
742   EXIM_DATUM_SIZE(value_datum) = (int)sizeof(time_t);
743   EXIM_DBPUT(dbm_file, key_datum, value_datum);
744   }
745
746 /* If sending failed, defer to try again - but if once is set the next
747 try will skip, of course. However, if there were no recipients in the
748 message, we do not fail. */
749
750 if (rc != 0)
751   if (rc == EXIT_NORECIPIENTS)
752     {
753     DEBUG(D_any) debug_printf("%s transport: message contained no recipients\n",
754       tblock->name);
755     }
756   else
757     {
758     addr->transport_return = DEFER;
759     addr->message = string_sprintf("Failed to send message from %s "
760       "transport (%d)", tblock->name, rc);
761     goto END_OFF;
762     }
763
764 /* Log the sending of the message if successful and required. If the file
765 fails to open, it's hard to know what to do. We cannot write to the Exim
766 log from here, since we may be running under an unprivileged uid. We don't
767 want to fail the delivery, since the message has been successfully sent. For
768 the moment, ignore open failures. Write the log entry as a single write() to a
769 file opened for appending, in order to avoid interleaving of output from
770 different processes. The log_buffer can be used exactly as for main log
771 writing. */
772
773 if (logfile)
774   {
775   int log_fd = Uopen(logfile, O_WRONLY|O_APPEND|O_CREAT, ob->mode);
776   if (log_fd >= 0)
777     {
778     gstring gs = { .size = LOG_BUFFER_SIZE, .ptr = 0, .s = log_buffer }, *g = &gs;
779
780     /* Use taint-unchecked routines for writing into log_buffer, trusting
781     that we'll never expand it. */
782
783     DEBUG(D_transport) debug_printf("logging message details\n");
784     g = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, "%s\n", tod_stamp(tod_log));
785     if (from)
786       g = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, "  From: %s\n", from);
787     if (to)
788       g = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, "  To: %s\n", to);
789     if (cc)
790       g = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, "  Cc: %s\n", cc);
791     if (bcc)
792       g = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, "  Bcc: %s\n", bcc);
793     if (subject)
794       g = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, "  Subject: %s\n", subject);
795     if (headers)
796       g = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, "  %s\n", headers);
797     if(write(log_fd, g->s, g->ptr) != g->ptr || close(log_fd))
798       DEBUG(D_transport) debug_printf("Problem writing log file %s for %s "
799         "transport\n", logfile, tblock->name);
800     }
801   else DEBUG(D_transport) debug_printf("Failed to open log file %s for %s "
802     "transport: %s\n", logfile, tblock->name, strerror(errno));
803   }
804
805 END_OFF:
806 if (dbm_file) EXIM_DBCLOSE(dbm_file);
807 if (cache_fd > 0) (void)close(cache_fd);
808
809 DEBUG(D_transport) debug_printf("%s transport succeeded\n", tblock->name);
810
811 return FALSE;
812 }
813
814 #endif  /*!MACRO_PREDEF*/
815 /* End of transport/autoreply.c */