Build: workaround inlining problems on Solaris
[exim.git] / src / src / spool_out.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 /* Functions for writing spool files, and moving them about. */
9
10
11 #include "exim.h"
12
13
14
15 /*************************************************
16 *       Deal with header writing errors          *
17 *************************************************/
18
19 /* This function is called immediately after errors in writing the spool, with
20 errno still set. It creates an error message, depending on the circumstances.
21 If errmsg is NULL, it logs the message and panic-dies. Otherwise errmsg is set
22 to point to the message, and -1 is returned. This function makes the code of
23 spool_write_header() a bit neater.
24
25 Arguments:
26    where      SW_RECEIVING, SW_DELIVERING, or SW_MODIFYING
27    errmsg     where to put the message; NULL => panic-die
28    s          text to add to log string
29    temp_name  name of temp file to unlink
30    f          FILE to close, if not NULL
31
32 Returns:      -1 if errmsg is not NULL; otherwise doesn't return
33 */
34
35 static int
36 spool_write_error(int where, uschar **errmsg, uschar *s, uschar *temp_name,
37   FILE *f)
38 {
39 uschar *msg = where == SW_RECEIVING
40   ? string_sprintf("spool file %s error while receiving from %s: %s", s,
41       sender_fullhost ? sender_fullhost : sender_ident,
42       strerror(errno))
43   : string_sprintf("spool file %s error while %s: %s", s,
44       where == SW_DELIVERING ? "delivering" : "modifying",
45       strerror(errno));
46
47 if (temp_name) Uunlink(temp_name);
48 if (f) (void)fclose(f);
49
50 if (errmsg)
51   *errmsg = msg;
52 else
53   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", msg);
54
55 return -1;
56 }
57
58
59
60 /*************************************************
61 *            Open file under temporary name      *
62 *************************************************/
63
64 /* This is used for opening spool files under a temporary name,
65 with a single attempt at deleting if they already exist.
66
67 Argument: temporary name for spool header file
68 Returns:  file descriptor of open file, or < 0 on failure, with errno unchanged
69 */
70
71 int
72 spool_open_temp(uschar *temp_name)
73 {
74 int fd = Uopen(temp_name, O_RDWR|O_CREAT|O_EXCL, SPOOL_MODE);
75
76 /* If the file already exists, something has gone wrong. This process may well
77 have previously created the file if it is delivering more than one address, but
78 it should have renamed it almost immediately. A file could, however, be left
79 around as a result of a system crash, and by coincidence this process might
80 have the same pid. We therefore have one go at unlinking it before giving up.
81 */
82
83 if (fd < 0 && errno == EEXIST)
84   {
85   DEBUG(D_any) debug_printf("%s exists: unlinking\n", temp_name);
86   Uunlink(temp_name);
87   fd = Uopen(temp_name, O_RDWR|O_CREAT|O_EXCL, SPOOL_MODE);
88   }
89
90 /* If the file has been opened, make sure the file's group is the Exim gid, and
91 double-check the mode because the group setting doesn't always get set
92 automatically. */
93
94 if (fd >= 0)
95   if (exim_fchown(fd, exim_uid, exim_gid, temp_name) || fchmod(fd, SPOOL_MODE))
96     {
97     DEBUG(D_any) debug_printf("failed setting perms on %s\n", temp_name);
98     (void) close(fd); fd = -1;
99     Uunlink(temp_name);
100     }
101
102 return fd;
103 }
104
105
106
107 static void
108 spool_var_write(FILE * fp, const uschar * name, const uschar * val)
109 {
110 if (is_tainted(val)) putc('-', fp);
111 fprintf(fp, "-%s %s\n", name, val);
112 }
113
114 /*************************************************
115 *          Write the header spool file           *
116 *************************************************/
117
118 /* Returns the size of the file for success; zero for failure. The file is
119 written under a temporary name, and then renamed. It's done this way so that it
120 works with re-writing the file on message deferral as well as for the initial
121 write. Whenever this function is called, the data file for the message should
122 be open and locked, thus preventing any other exim process from working on this
123 message.
124
125 Argument:
126   id      the message id
127   where   SW_RECEIVING, SW_DELIVERING, or SW_MODIFYING
128   errmsg  where to put an error message; if NULL, panic-die on error
129
130 Returns:  the size of the header texts on success;
131           negative on writing failure, unless errmsg == NULL
132 */
133
134 int
135 spool_write_header(uschar *id, int where, uschar **errmsg)
136 {
137 int fd;
138 int size_correction;
139 FILE * fp;
140 struct stat statbuf;
141 uschar * tname;
142 uschar * fname;
143
144 tname = spool_fname(US"input", message_subdir, US"hdr.", message_id);
145
146 if ((fd = spool_open_temp(tname)) < 0)
147   return spool_write_error(where, errmsg, US"open", NULL, NULL);
148 fp = fdopen(fd, "wb");
149 DEBUG(D_receive|D_deliver) debug_printf("Writing spool header file: %s\n", tname);
150
151 /* We now have an open file to which the header data is to be written. Start
152 with the file's leaf name, to make the file self-identifying. Continue with the
153 identity of the submitting user, followed by the sender's address. The sender's
154 address is enclosed in <> because it might be the null address. Then write the
155 received time and the number of warning messages that have been sent. */
156
157 fprintf(fp, "%s-H\n", message_id);
158 fprintf(fp, "%.63s %ld %ld\n", originator_login, (long int)originator_uid,
159   (long int)originator_gid);
160 fprintf(fp, "<%s>\n", sender_address);
161 fprintf(fp, "%d %d\n", (int)received_time.tv_sec, warning_count);
162
163 fprintf(fp, "-received_time_usec .%06d\n", (int)received_time.tv_usec);
164
165 /* If there is information about a sending host, remember it. The HELO
166 data can be set for local SMTP as well as remote. */
167
168 if (sender_helo_name) spool_var_write(fp, US"helo_name", sender_helo_name);
169
170 if (sender_host_address)
171   {
172   if (is_tainted(sender_host_address)) putc('-', fp);
173   fprintf(fp, "-host_address %s.%d\n", sender_host_address, sender_host_port);
174   if (sender_host_name)
175     spool_var_write(fp, US"host_name", sender_host_name);
176   if (sender_host_authenticated)
177     spool_var_write(fp, US"host_auth", sender_host_authenticated);
178   }
179
180 /* Also about the interface a message came in on */
181
182 if (interface_address)
183   {
184   if (is_tainted(interface_address)) putc('-', fp);
185   fprintf(fp, "-interface_address %s.%d\n", interface_address, interface_port);
186   }
187
188 if (smtp_active_hostname != primary_hostname)
189   spool_var_write(fp, US"active_hostname", smtp_active_hostname);
190
191 /* Likewise for any ident information; for local messages this is
192 likely to be the same as originator_login, but will be different if
193 the originator was root, forcing a different ident. */
194
195 if (sender_ident)
196   spool_var_write(fp, US"ident", sender_ident);
197
198 /* Ditto for the received protocol */
199
200 if (received_protocol)
201   spool_var_write(fp, US"received_protocol", received_protocol);
202
203 /* Preserve any ACL variables that are set. */
204
205 tree_walk(acl_var_c, &acl_var_write, fp);
206 tree_walk(acl_var_m, &acl_var_write, fp);
207
208 /* Now any other data that needs to be remembered. */
209
210 if (f.spool_file_wireformat)
211   fprintf(fp, "-spool_file_wireformat\n");
212 else
213   fprintf(fp, "-body_linecount %d\n", body_linecount);
214 fprintf(fp, "-max_received_linelength %d\n", max_received_linelength);
215
216 if (body_zerocount > 0) fprintf(fp, "-body_zerocount %d\n", body_zerocount);
217
218 if (authenticated_id)
219   spool_var_write(fp, US"auth_id", authenticated_id);
220 if (authenticated_sender)
221   spool_var_write(fp, US"auth_sender", authenticated_sender);
222
223 if (f.allow_unqualified_recipient) fprintf(fp, "-allow_unqualified_recipient\n");
224 if (f.allow_unqualified_sender) fprintf(fp, "-allow_unqualified_sender\n");
225 if (f.deliver_firsttime) fprintf(fp, "-deliver_firsttime\n");
226 if (f.deliver_freeze) fprintf(fp, "-frozen " TIME_T_FMT "\n", deliver_frozen_at);
227 if (f.dont_deliver) fprintf(fp, "-N\n");
228 if (host_lookup_deferred) fprintf(fp, "-host_lookup_deferred\n");
229 if (host_lookup_failed) fprintf(fp, "-host_lookup_failed\n");
230 if (f.sender_local) fprintf(fp, "-local\n");
231 if (f.local_error_message) fprintf(fp, "-localerror\n");
232 #ifdef HAVE_LOCAL_SCAN
233 if (local_scan_data) spool_var_write(fp, US"local_scan", local_scan_data);
234 #endif
235 #ifdef WITH_CONTENT_SCAN
236 if (spam_bar)       spool_var_write(fp, US"spam_bar",       spam_bar);
237 if (spam_score)     spool_var_write(fp, US"spam_score",     spam_score);
238 if (spam_score_int) spool_var_write(fp, US"spam_score_int", spam_score_int);
239 #endif
240 if (f.deliver_manual_thaw) fprintf(fp, "-manual_thaw\n");
241 if (f.sender_set_untrusted) fprintf(fp, "-sender_set_untrusted\n");
242
243 #ifdef EXPERIMENTAL_BRIGHTMAIL
244 if (bmi_verdicts) spool_var_write(fp, US"bmi_verdicts", bmi_verdicts);
245 #endif
246
247 #ifndef DISABLE_TLS
248 if (tls_in.certificate_verified) fprintf(fp, "-tls_certificate_verified\n");
249 if (tls_in.cipher) spool_var_write(fp, US"tls_cipher", tls_in.cipher);
250 if (tls_in.peercert)
251   {
252   (void) tls_export_cert(big_buffer, big_buffer_size, tls_in.peercert);
253   fprintf(fp, "--tls_peercert %s\n", CS big_buffer);
254   }
255 if (tls_in.peerdn)       spool_var_write(fp, US"tls_peerdn", string_printing(tls_in.peerdn));
256 if (tls_in.sni)          spool_var_write(fp, US"tls_sni",    string_printing(tls_in.sni));
257 if (tls_in.ourcert)
258   {
259   (void) tls_export_cert(big_buffer, big_buffer_size, tls_in.ourcert);
260   fprintf(fp, "-tls_ourcert %s\n", CS big_buffer);
261   }
262 if (tls_in.ocsp)         fprintf(fp, "-tls_ocsp %d\n",   tls_in.ocsp);
263 # ifdef EXPERIMENTAL_TLS_RESUME
264 fprintf(fp, "-tls_resumption %c\n", 'A' + tls_in.resumption);
265 # endif
266 #endif
267
268 #ifdef SUPPORT_I18N
269 if (message_smtputf8)
270   {
271   fprintf(fp, "-smtputf8\n");
272   if (message_utf8_downconvert)
273     fprintf(fp, "-utf8_%sdowncvt\n", message_utf8_downconvert < 0 ? "opt" : "");
274   }
275 #endif
276
277 /* Write the dsn flags to the spool header file */
278 DEBUG(D_deliver) debug_printf("DSN: Write SPOOL: -dsn_envid %s\n", dsn_envid);
279 if (dsn_envid) fprintf(fp, "-dsn_envid %s\n", dsn_envid);
280 DEBUG(D_deliver) debug_printf("DSN: Write SPOOL  :-dsn_ret %d\n", dsn_ret);
281 if (dsn_ret) fprintf(fp, "-dsn_ret %d\n", dsn_ret);
282
283 /* To complete the envelope, write out the tree of non-recipients, followed by
284 the list of recipients. These won't be disjoint the first time, when no
285 checking has been done. If a recipient is a "one-time" alias, it is followed by
286 a space and its parent address number (pno). */
287
288 tree_write(tree_nonrecipients, fp);
289 fprintf(fp, "%d\n", recipients_count);
290 for (int i = 0; i < recipients_count; i++)
291   {
292   recipient_item *r = recipients_list + i;
293
294   DEBUG(D_deliver) debug_printf("DSN: Flags: 0x%x\n", r->dsn_flags);
295
296   if (r->pno < 0 && !r->errors_to && r->dsn_flags == 0)
297     fprintf(fp, "%s\n", r->address);
298   else
299     {
300     uschar * errors_to = r->errors_to ? r->errors_to : US"";
301     /* for DSN SUPPORT extend exim 4 spool in a compatible way by
302     adding new values upfront and add flag 0x02 */
303     uschar * orcpt = r->orcpt ? r->orcpt : US"";
304
305     fprintf(fp, "%s %s %d,%d %s %d,%d#3\n", r->address, orcpt, Ustrlen(orcpt),
306       r->dsn_flags, errors_to, Ustrlen(errors_to), r->pno);
307     }
308
309     DEBUG(D_deliver) debug_printf("DSN: **** SPOOL_OUT - "
310       "address: <%s> errorsto: <%s> orcpt: <%s> dsn_flags: 0x%x\n",
311       r->address, r->errors_to, r->orcpt, r->dsn_flags);
312   }
313
314 /* Put a blank line before the headers */
315
316 fprintf(fp, "\n");
317
318 /* Save the size of the file so far so we can subtract it from the final length
319 to get the actual size of the headers. */
320
321 fflush(fp);
322 if (fstat(fd, &statbuf))
323   return spool_write_error(where, errmsg, US"fstat", tname, fp);
324 size_correction = statbuf.st_size;
325
326 /* Finally, write out the message's headers. To make it easier to read them
327 in again, precede each one with the count of its length. Make the count fixed
328 length to aid human eyes when debugging and arrange for it not be included in
329 the size. It is followed by a space for normal headers, a flagging letter for
330 various other headers, or an asterisk for old headers that have been rewritten.
331 These are saved as a record for debugging. Don't included them in the message's
332 size. */
333
334 for (header_line * h = header_list; h; h = h->next)
335   {
336   fprintf(fp, "%03d%c %s", h->slen, h->type, h->text);
337   size_correction += 5;
338   if (h->type == '*') size_correction += h->slen;
339   }
340
341 /* Flush and check for any errors while writing */
342
343 if (fflush(fp) != 0 || ferror(fp))
344   return spool_write_error(where, errmsg, US"write", tname, fp);
345
346 /* Force the file's contents to be written to disk. Note that fflush()
347 just pushes it out of C, and fclose() doesn't guarantee to do the write
348 either. That's just the way Unix works... */
349
350 if (EXIMfsync(fileno(fp)) < 0)
351   return spool_write_error(where, errmsg, US"sync", tname, fp);
352
353 /* Get the size of the file, and close it. */
354
355 if (fstat(fd, &statbuf) != 0)
356   return spool_write_error(where, errmsg, US"fstat", tname, NULL);
357 if (fclose(fp) != 0)
358   return spool_write_error(where, errmsg, US"close", tname, NULL);
359
360 /* Rename the file to its correct name, thereby replacing any previous
361 incarnation. */
362
363 fname = spool_fname(US"input", message_subdir, id, US"-H");
364 DEBUG(D_receive|D_deliver) debug_printf("Renaming spool header file: %s\n", fname);
365
366 if (Urename(tname, fname) < 0)
367   return spool_write_error(where, errmsg, US"rename", tname, NULL);
368
369 /* Linux (and maybe other OS?) does not automatically sync a directory after
370 an operation like rename. We therefore have to do it forcibly ourselves in
371 these cases, to make sure the file is actually accessible on disk, as opposed
372 to just the data being accessible from a file in lost+found. Linux also has
373 O_DIRECTORY, for opening a directory.
374
375 However, it turns out that some file systems (some versions of NFS?) do not
376 support directory syncing. It seems safe enough to ignore EINVAL to cope with
377 these cases. One hack on top of another... but that's life. */
378
379 #ifdef NEED_SYNC_DIRECTORY
380
381 tname = spool_fname(US"input", message_subdir, US".", US"");
382
383 # ifndef O_DIRECTORY
384 #  define O_DIRECTORY 0
385 # endif
386
387 if ((fd = Uopen(tname, O_RDONLY|O_DIRECTORY, 0)) < 0)
388   return spool_write_error(where, errmsg, US"directory open", fname, NULL);
389
390 if (EXIMfsync(fd) < 0 && errno != EINVAL)
391   return spool_write_error(where, errmsg, US"directory sync", fname, NULL);
392
393 if (close(fd) < 0)
394   return spool_write_error(where, errmsg, US"directory close", fname, NULL);
395
396 #endif  /* NEED_SYNC_DIRECTORY */
397
398 /* Return the number of characters in the headers, which is the file size, less
399 the preliminary stuff, less the additional count fields on the headers. */
400
401 DEBUG(D_receive) debug_printf("Size of headers = %d\n",
402   (int)(statbuf.st_size - size_correction));
403
404 return statbuf.st_size - size_correction;
405 }
406
407
408 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
409
410 /************************************************
411 *              Make a hard link                 *
412 ************************************************/
413
414 /* Used by spool_move_message() below. Note re the use of sprintf(): the value
415 of spool_directory is checked to ensure that it is less than 200 characters at
416 start-up time.
417
418 Arguments:
419   dir        base directory name
420   subdir     subdirectory name
421   id         message id
422   suffix     suffix to add to id
423   from       source directory prefix
424   to         destination directory prefix
425   noentok    if TRUE, absence of file is not an error
426
427 Returns:     TRUE if all went well
428              FALSE, having panic logged if not
429 */
430
431 static BOOL
432 make_link(uschar *dir, uschar *subdir, uschar *id, uschar *suffix, uschar *from,
433   uschar *to, BOOL noentok)
434 {
435 uschar * fname = spool_fname(string_sprintf("%s%s", from, dir), subdir, id, suffix);
436 uschar * tname = spool_fname(string_sprintf("%s%s", to,   dir), subdir, id, suffix);
437 if (Ulink(fname, tname) < 0 && (!noentok || errno != ENOENT))
438   {
439   log_write(0, LOG_MAIN|LOG_PANIC, "link(\"%s\", \"%s\") failed while moving "
440     "message: %s", fname, tname, strerror(errno));
441   return FALSE;
442   }
443 return TRUE;
444 }
445
446
447
448 /************************************************
449 *                Break a link                   *
450 ************************************************/
451
452 /* Used by spool_move_message() below. Note re the use of sprintf(): the value
453 of spool_directory is checked to ensure that it is less than 200 characters at
454 start-up time.
455
456 Arguments:
457   dir        base directory name
458   subdir     subdirectory name
459   id         message id
460   suffix     suffix to add to id
461   from       source directory prefix
462   noentok    if TRUE, absence of file is not an error
463
464 Returns:     TRUE if all went well
465              FALSE, having panic logged if not
466 */
467
468 static BOOL
469 break_link(uschar *dir, uschar *subdir, uschar *id, uschar *suffix, uschar *from,
470   BOOL noentok)
471 {
472 uschar * fname = spool_fname(string_sprintf("%s%s", from, dir), subdir, id, suffix);
473 if (Uunlink(fname) < 0 && (!noentok || errno != ENOENT))
474   {
475   log_write(0, LOG_MAIN|LOG_PANIC, "unlink(\"%s\") failed while moving "
476     "message: %s", fname, strerror(errno));
477   return FALSE;
478   }
479 return TRUE;
480 }
481
482
483
484 /************************************************
485 *            Move message files                 *
486 ************************************************/
487
488 /* Move the files for a message (-H, -D, and msglog) from one directory (or
489 hierarchy) to another. It is assume that there is no -J file in existence when
490 this is done. At present, this is used only when move_frozen_messages is set,
491 so compile it only when that support is configured.
492
493 Arguments:
494   id          the id of the message to be delivered
495   subdir      the subdirectory name, or an empty string
496   from        a prefix for "input" or "msglog" for where the message is now
497   to          a prefix for "input" or "msglog" for where the message is to go
498
499 Returns:      TRUE if all is well
500               FALSE if not, with error logged in panic and main logs
501 */
502
503 BOOL
504 spool_move_message(uschar *id, uschar *subdir, uschar *from, uschar *to)
505 {
506 /* Create any output directories that do not exist. */
507
508 (void) directory_make(spool_directory,
509   spool_sname(string_sprintf("%sinput", to), subdir),
510   INPUT_DIRECTORY_MODE, TRUE);
511 (void) directory_make(spool_directory,
512   spool_sname(string_sprintf("%smsglog", to), subdir),
513   INPUT_DIRECTORY_MODE, TRUE);
514
515 /* Move the message by first creating new hard links for all the files, and
516 then removing the old links. When moving messages onto the main spool, the -H
517 file should be set up last, because that's the one that tells Exim there is a
518 message to be delivered, so we create its new link last and remove its old link
519 first. Programs that look at the alternate directories should follow the same
520 rule of waiting for a -H file before doing anything. When moving messages off
521 the mail spool, the -D file should be open and locked at the time, thus keeping
522 Exim's hands off. */
523
524 if (!make_link(US"msglog", subdir, id, US"", from, to, TRUE) ||
525     !make_link(US"input",  subdir, id, US"-D", from, to, FALSE) ||
526     !make_link(US"input",  subdir, id, US"-H", from, to, FALSE))
527   return FALSE;
528
529 if (!break_link(US"input",  subdir, id, US"-H", from, FALSE) ||
530     !break_link(US"input",  subdir, id, US"-D", from, FALSE) ||
531     !break_link(US"msglog", subdir, id, US"", from, TRUE))
532   return FALSE;
533
534 log_write(0, LOG_MAIN, "moved from %sinput, %smsglog to %sinput, %smsglog",
535    from, from, to, to);
536
537 return TRUE;
538 }
539
540 #endif
541
542 /* End of spool_out.c */
543 /* vi: aw ai sw=2
544 */