src/src/spool_out.c

   1 /* $Cambridge: exim/src/src/spool_out.c,v 1.14 2007/06/22 14:38:58 ph10 Exp $ */
   2
   3 /*************************************************
   4 *     Exim - an Internet mail transport agent    *
   5 *************************************************/
   6
   7 /* Copyright (c) University of Cambridge 1995 - 2007 */
   8 /* See the file NOTICE for conditions of use and distribution. */
   9
  10 /* Functions for writing spool files, and moving them about. */
  11
  12
  13 #include "exim.h"
  14
  15
  16
  17 /*************************************************
  18 *       Deal with header writing errors          *
  19 *************************************************/
  20
  21 /* This function is called immediately after errors in writing the spool, with
  22 errno still set. It creates and error message, depending on the circumstances.
  23 If errmsg is NULL, it logs the message and panic-dies. Otherwise errmsg is set
  24 to point to the message, and -1 is returned. This function makes the code of
  25 spool_write_header() a bit neater.
  26
  27 Arguments:
  28    where      SW_RECEIVING, SW_DELIVERING, or SW_MODIFYING
  29    errmsg     where to put the message; NULL => panic-die
  30    s          text to add to log string
  31    temp_name  name of temp file to unlink
  32    f          FILE to close, if not NULL
  33
  34 Returns:      -1 if errmsg is not NULL; otherwise doesn't return
  35 */
  36
  37 static int
  38 spool_write_error(int where, uschar **errmsg, uschar *s, uschar *temp_name,
  39   FILE *f)
  40 {
  41 uschar *msg = (where == SW_RECEIVING)?
  42   string_sprintf("spool file %s error while receiving from %s: %s", s,
  43     (sender_fullhost != NULL)? sender_fullhost : sender_ident,
  44     strerror(errno))
  45   :
  46   string_sprintf("spool file %s error while %s: %s", s,
  47     (where == SW_DELIVERING)? "delivering" : "modifying",
  48     strerror(errno));
  49
  50 if (temp_name != NULL) Uunlink(temp_name);
  51 if (f != NULL) (void)fclose(f);
  52
  53 if (errmsg == NULL)
  54   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", msg);
  55 else
  56   *errmsg = msg;
  57
  58 return -1;
  59 }
  60
  61
  62
  63 /*************************************************
  64 *            Open file under temporary name      *
  65 *************************************************/
  66
  67 /* This is used for opening spool files under a temporary name,
  68 with a single attempt at deleting if they already exist.
  69
  70 Argument: temporary name for spool header file
  71 Returns:  file descriptor of open file, or < 0 on failure, with errno unchanged
  72 */
  73
  74 int
  75 spool_open_temp(uschar *temp_name)
  76 {
  77 int fd = Uopen(temp_name, O_RDWR|O_CREAT|O_EXCL, SPOOL_MODE);
  78
  79 /* If the file already exists, something has gone wrong. This process may well
  80 have previously created the file if it is delivering more than one address, but
  81 it should have renamed it almost immediately. A file could, however, be left
  82 around as a result of a system crash, and by coincidence this process might
  83 have the same pid. We therefore have one go at unlinking it before giving up.
  84 */
  85
  86 if (fd < 0 && errno == EEXIST)
  87   {
  88   DEBUG(D_any) debug_printf("%s exists: unlinking\n", temp_name);
  89   Uunlink(temp_name);
  90   fd = Uopen(temp_name, O_RDWR|O_CREAT|O_EXCL, SPOOL_MODE);
  91   }
  92
  93 /* If the file has been opened, make sure the file's group is the Exim gid, and
  94 double-check the mode because the group setting doesn't always get set
  95 automatically. */
  96
  97 if (fd >= 0)
  98   {
  99   (void)fchown(fd, exim_uid, exim_gid);
 100   (void)fchmod(fd, SPOOL_MODE);
 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 %d\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_score_int != NULL) fprintf(f,"-spam_score_int %s\n", spam_score_int);
 222 #endif
 223 if (deliver_manual_thaw) fprintf(f, "-manual_thaw\n");
 224 if (sender_set_untrusted) fprintf(f, "-sender_set_untrusted\n");
 225
 226 #ifdef EXPERIMENTAL_BRIGHTMAIL
 227 if (bmi_verdicts != NULL) fprintf(f, "-bmi_verdicts %s\n", bmi_verdicts);
 228 #endif
 229
 230 #ifdef SUPPORT_TLS
 231 if (tls_certificate_verified) fprintf(f, "-tls_certificate_verified\n");
 232 if (tls_cipher != NULL) fprintf(f, "-tls_cipher %s\n", tls_cipher);
 233 if (tls_peerdn != NULL) fprintf(f, "-tls_peerdn %s\n", tls_peerdn);
 234 #endif
 235
 236 /* To complete the envelope, write out the tree of non-recipients, followed by
 237 the list of recipients. These won't be disjoint the first time, when no
 238 checking has been done. If a recipient is a "one-time" alias, it is followed by
 239 a space and its parent address number (pno). */
 240
 241 tree_write(tree_nonrecipients, f);
 242 fprintf(f, "%d\n", recipients_count);
 243 for (i = 0; i < recipients_count; i++)
 244   {
 245   recipient_item *r = recipients_list + i;
 246   if (r->pno < 0 && r->errors_to == NULL)
 247     fprintf(f, "%s\n", r->address);
 248   else
 249     {
 250     uschar *errors_to = (r->errors_to == NULL)? US"" : r->errors_to;
 251     fprintf(f, "%s %s %d,%d#1\n", r->address, errors_to,
 252       Ustrlen(errors_to), r->pno);
 253     }
 254   }
 255
 256 /* Put a blank line before the headers */
 257
 258 fprintf(f, "\n");
 259
 260 /* Save the size of the file so far so we can subtract it from the final length
 261 to get the actual size of the headers. */
 262
 263 fflush(f);
 264 fstat(fd, &statbuf);
 265 size_correction = statbuf.st_size;
 266
 267 /* Finally, write out the message's headers. To make it easier to read them
 268 in again, precede each one with the count of its length. Make the count fixed
 269 length to aid human eyes when debugging and arrange for it not be included in
 270 the size. It is followed by a space for normal headers, a flagging letter for
 271 various other headers, or an asterisk for old headers that have been rewritten.
 272 These are saved as a record for debugging. Don't included them in the message's
 273 size. */
 274
 275 for (h = header_list; h != NULL; h = h->next)
 276   {
 277   fprintf(f, "%03d%c %s", h->slen, h->type, h->text);
 278   size_correction += 5;
 279   if (h->type == '*') size_correction += h->slen;
 280   }
 281
 282 /* Flush and check for any errors while writing */
 283
 284 if (fflush(f) != 0 || ferror(f))
 285   return spool_write_error(where, errmsg, US"write", temp_name, f);
 286
 287 /* Force the file's contents to be written to disk. Note that fflush()
 288 just pushes it out of C, and fclose() doesn't guarantee to do the write
 289 either. That's just the way Unix works... */
 290
 291 if (EXIMfsync(fileno(f)) < 0)
 292   return spool_write_error(where, errmsg, US"sync", temp_name, f);
 293
 294 /* Get the size of the file, and close it. */
 295
 296 fstat(fd, &statbuf);
 297 if (fclose(f) != 0)
 298   return spool_write_error(where, errmsg, US"close", temp_name, NULL);
 299
 300 /* Rename the file to its correct name, thereby replacing any previous
 301 incarnation. */
 302
 303 sprintf(CS name, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
 304
 305 if (Urename(temp_name, name) < 0)
 306   return spool_write_error(where, errmsg, US"rename", temp_name, NULL);
 307
 308 /* Linux (and maybe other OS?) does not automatically sync a directory after
 309 an operation like rename. We therefore have to do it forcibly ourselves in
 310 these cases, to make sure the file is actually accessible on disk, as opposed
 311 to just the data being accessible from a file in lost+found. Linux also has
 312 O_DIRECTORY, for opening a directory.
 313
 314 However, it turns out that some file systems (some versions of NFS?) do not
 315 support directory syncing. It seems safe enough to ignore EINVAL to cope with
 316 these cases. One hack on top of another... but that's life. */
 317
 318 #ifdef NEED_SYNC_DIRECTORY
 319
 320 sprintf(CS temp_name, "%s/input/%s/.", spool_directory, message_subdir);
 321
 322 #ifndef O_DIRECTORY
 323 #define O_DIRECTORY 0
 324 #endif
 325
 326 if ((fd = Uopen(temp_name, O_RDONLY|O_DIRECTORY, 0)) < 0)
 327   return spool_write_error(where, errmsg, US"directory open", name, NULL);
 328
 329 if (EXIMfsync(fd) < 0 && errno != EINVAL)
 330   return spool_write_error(where, errmsg, US"directory sync", name, NULL);
 331
 332 if (close(fd) < 0)
 333   return spool_write_error(where, errmsg, US"directory close", name, NULL);
 334
 335 #endif  /* NEED_SYNC_DIRECTORY */
 336
 337 /* Return the number of characters in the headers, which is the file size, less
 338 the prelimary stuff, less the additional count fields on the headers. */
 339
 340 DEBUG(D_receive) debug_printf("Size of headers = %d\n",
 341   (int)(statbuf.st_size - size_correction));
 342
 343 return statbuf.st_size - size_correction;
 344 }
 345
 346
 347 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
 348
 349 /************************************************
 350 *              Make a hard link                 *
 351 ************************************************/
 352
 353 /* Used by spool_move_message() below. Note re the use of sprintf(): the value
 354 of spool_directory is checked to ensure that it is less than 200 characters at
 355 start-up time.
 356
 357 Arguments:
 358   dir        base directory name
 359   subdir     subdirectory name
 360   id         message id
 361   suffix     suffix to add to id
 362   from       source directory prefix
 363   to         destination directory prefix
 364   noentok    if TRUE, absence of file is not an error
 365
 366 Returns:     TRUE if all went well
 367              FALSE, having panic logged if not
 368 */
 369
 370 static BOOL
 371 make_link(uschar *dir, uschar *subdir, uschar *id, uschar *suffix, uschar *from,
 372   uschar *to, BOOL noentok)
 373 {
 374 uschar f[256], t[256];
 375 sprintf(CS f, "%s/%s%s/%s/%s%s", spool_directory, from, dir, subdir, id, suffix);
 376 sprintf(CS t, "%s/%s%s/%s/%s%s", spool_directory, to, dir, subdir, id, suffix);
 377 if (Ulink(f, t) < 0 && (!noentok || errno != ENOENT))
 378   {
 379   log_write(0, LOG_MAIN|LOG_PANIC, "link(\"%s\", \"%s\") failed while moving "
 380     "message: %s", f, t, strerror(errno));
 381   return FALSE;
 382   }
 383 return TRUE;
 384 }
 385
 386
 387
 388 /************************************************
 389 *                Break a link                   *
 390 ************************************************/
 391
 392 /* Used by spool_move_message() below. Note re the use of sprintf(): the value
 393 of spool_directory is checked to ensure that it is less than 200 characters at
 394 start-up time.
 395
 396 Arguments:
 397   dir        base directory name
 398   subdir     subdirectory name
 399   id         message id
 400   suffix     suffix to add to id
 401   from       source directory prefix
 402   noentok    if TRUE, absence of file is not an error
 403
 404 Returns:     TRUE if all went well
 405              FALSE, having panic logged if not
 406 */
 407
 408 static BOOL
 409 break_link(uschar *dir, uschar *subdir, uschar *id, uschar *suffix, uschar *from,
 410   BOOL noentok)
 411 {
 412 uschar f[256];
 413 sprintf(CS f, "%s/%s%s/%s/%s%s", spool_directory, from, dir, subdir, id, suffix);
 414 if (Uunlink(f) < 0 && (!noentok || errno != ENOENT))
 415   {
 416   log_write(0, LOG_MAIN|LOG_PANIC, "unlink(\"%s\") failed while moving "
 417     "message: %s", f, strerror(errno));
 418   return FALSE;
 419   }
 420 return TRUE;
 421 }
 422
 423
 424
 425 /************************************************
 426 *            Move message files                 *
 427 ************************************************/
 428
 429 /* Move the files for a message (-H, -D, and msglog) from one directory (or
 430 hierarchy) to another. It is assume that there is no -J file in existence when
 431 this is done. At present, this is used only when move_frozen_messages is set,
 432 so compile it only when that support is configured.
 433
 434 Arguments:
 435   id          the id of the message to be delivered
 436   subdir      the subdirectory name, or an empty string
 437   from        a prefix for "input" or "msglog" for where the message is now
 438   to          a prefix for "input" or "msglog" for where the message is to go
 439
 440 Returns:      TRUE if all is well
 441               FALSE if not, with error logged in panic and main logs
 442 */
 443
 444 BOOL
 445 spool_move_message(uschar *id, uschar *subdir, uschar *from, uschar *to)
 446 {
 447 /* Create any output directories that do not exist. */
 448
 449 sprintf(CS big_buffer, "%sinput/%s", to, subdir);
 450 (void)directory_make(spool_directory, big_buffer, INPUT_DIRECTORY_MODE, TRUE);
 451 sprintf(CS big_buffer, "%smsglog/%s", to, subdir);
 452 (void)directory_make(spool_directory, big_buffer, INPUT_DIRECTORY_MODE, TRUE);
 453
 454 /* Move the message by first creating new hard links for all the files, and
 455 then removing the old links. When moving messages onto the main spool, the -H
 456 file should be set up last, because that's the one that tells Exim there is a
 457 message to be delivered, so we create its new link last and remove its old link
 458 first. Programs that look at the alternate directories should follow the same
 459 rule of waiting for a -H file before doing anything. When moving messsages off
 460 the mail spool, the -D file should be open and locked at the time, thus keeping
 461 Exim's hands off. */
 462
 463 if (!make_link(US"msglog", subdir, id, US"", from, to, TRUE) ||
 464     !make_link(US"input",  subdir, id, US"-D", from, to, FALSE) ||
 465     !make_link(US"input",  subdir, id, US"-H", from, to, FALSE))
 466   return FALSE;
 467
 468 if (!break_link(US"input",  subdir, id, US"-H", from, FALSE) ||
 469     !break_link(US"input",  subdir, id, US"-D", from, FALSE) ||
 470     !break_link(US"msglog", subdir, id, US"", from, TRUE))
 471   return FALSE;
 472
 473 log_write(0, LOG_MAIN, "moved from %sinput, %smsglog to %sinput, %smsglog",
 474    from, from, to, to);
 475
 476 return TRUE;
 477 }
 478
 479 #endif
 480
 481 /* End of spool_out.c */