src/src/spool_out.c

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