1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2012 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for writing spool files, and moving them about. */
15 /*************************************************
16 * Deal with header writing errors *
17 *************************************************/
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.
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
32 Returns: -1 if errmsg is not NULL; otherwise doesn't return
36 spool_write_error(int where, uschar **errmsg, uschar *s, uschar *temp_name,
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,
44 string_sprintf("spool file %s error while %s: %s", s,
45 (where == SW_DELIVERING)? "delivering" : "modifying",
48 if (temp_name != NULL) Uunlink(temp_name);
49 if (f != NULL) (void)fclose(f);
52 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", msg);
61 /*************************************************
62 * Open file under temporary name *
63 *************************************************/
65 /* This is used for opening spool files under a temporary name,
66 with a single attempt at deleting if they already exist.
68 Argument: temporary name for spool header file
69 Returns: file descriptor of open file, or < 0 on failure, with errno unchanged
73 spool_open_temp(uschar *temp_name)
75 int fd = Uopen(temp_name, O_RDWR|O_CREAT|O_EXCL, SPOOL_MODE);
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.
84 if (fd < 0 && errno == EEXIST)
86 DEBUG(D_any) debug_printf("%s exists: unlinking\n", temp_name);
88 fd = Uopen(temp_name, O_RDWR|O_CREAT|O_EXCL, SPOOL_MODE);
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
96 if (fchown(fd, exim_uid, exim_gid) || fchmod(fd, SPOOL_MODE))
98 DEBUG(D_any) debug_printf("failed setting perms on %s\n", temp_name);
99 (void) close(fd); fd = -1;
108 /*************************************************
109 * Write the header spool file *
110 *************************************************/
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
121 where SW_RECEIVING, SW_DELIVERING, or SW_MODIFYING
122 errmsg where to put an error message; if NULL, panic-die on error
124 Returns: the size of the header texts on success;
125 negative on writing failure, unless errmsg == NULL
129 spool_write_header(uschar *id, int where, uschar **errmsg)
138 uschar temp_name[256];
140 sprintf(CS temp_name, "%s/input/%s/hdr.%d", spool_directory, message_subdir,
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");
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. */
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);
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. */
162 if (sender_helo_name != NULL)
163 fprintf(f, "-helo_name %s\n", sender_helo_name);
165 if (sender_host_address != NULL)
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);
174 /* Also about the interface a message came in on */
176 if (interface_address != NULL)
177 fprintf(f, "-interface_address %s.%d\n", interface_address, interface_port);
179 if (smtp_active_hostname != primary_hostname)
180 fprintf(f, "-active_hostname %s\n", smtp_active_hostname);
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. */
186 if (sender_ident != NULL) fprintf(f, "-ident %s\n", sender_ident);
188 /* Ditto for the received protocol */
190 if (received_protocol != NULL)
191 fprintf(f, "-received_protocol %s\n", received_protocol);
193 /* Preserve any ACL variables that are set. */
195 tree_walk(acl_var_c, &acl_var_write, f);
196 tree_walk(acl_var_m, &acl_var_write, f);
198 /* Now any other data that needs to be remembered. */
200 fprintf(f, "-body_linecount %d\n", body_linecount);
201 fprintf(f, "-max_received_linelength %d\n", max_received_linelength);
203 if (body_zerocount > 0) fprintf(f, "-body_zerocount %d\n", body_zerocount);
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);
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);
223 if (deliver_manual_thaw) fprintf(f, "-manual_thaw\n");
224 if (sender_set_untrusted) fprintf(f, "-sender_set_untrusted\n");
226 #ifdef EXPERIMENTAL_BRIGHTMAIL
227 if (bmi_verdicts != NULL) fprintf(f, "-bmi_verdicts %s\n", bmi_verdicts);
231 if (tls_in.certificate_verified) fprintf(f, "-tls_certificate_verified\n");
232 if (tls_in.cipher) fprintf(f, "-tls_cipher %s\n", tls_in.cipher);
235 (void) tls_export_cert(big_buffer, big_buffer_size, tls_in.peercert);
236 fprintf(f, "-tls_peercert %s\n", CS big_buffer);
238 if (tls_in.peerdn) fprintf(f, "-tls_peerdn %s\n", string_printing(tls_in.peerdn));
239 if (tls_in.sni) fprintf(f, "-tls_sni %s\n", string_printing(tls_in.sni));
242 (void) tls_export_cert(big_buffer, big_buffer_size, tls_in.ourcert);
243 fprintf(f, "-tls_ourcert %s\n", CS big_buffer);
247 /* To complete the envelope, write out the tree of non-recipients, followed by
248 the list of recipients. These won't be disjoint the first time, when no
249 checking has been done. If a recipient is a "one-time" alias, it is followed by
250 a space and its parent address number (pno). */
252 tree_write(tree_nonrecipients, f);
253 fprintf(f, "%d\n", recipients_count);
254 for (i = 0; i < recipients_count; i++)
256 recipient_item *r = recipients_list + i;
257 if (r->pno < 0 && r->errors_to == NULL)
258 fprintf(f, "%s\n", r->address);
261 uschar *errors_to = (r->errors_to == NULL)? US"" : r->errors_to;
262 fprintf(f, "%s %s %d,%d#1\n", r->address, errors_to,
263 Ustrlen(errors_to), r->pno);
267 /* Put a blank line before the headers */
271 /* Save the size of the file so far so we can subtract it from the final length
272 to get the actual size of the headers. */
276 size_correction = statbuf.st_size;
278 /* Finally, write out the message's headers. To make it easier to read them
279 in again, precede each one with the count of its length. Make the count fixed
280 length to aid human eyes when debugging and arrange for it not be included in
281 the size. It is followed by a space for normal headers, a flagging letter for
282 various other headers, or an asterisk for old headers that have been rewritten.
283 These are saved as a record for debugging. Don't included them in the message's
286 for (h = header_list; h != NULL; h = h->next)
288 fprintf(f, "%03d%c %s", h->slen, h->type, h->text);
289 size_correction += 5;
290 if (h->type == '*') size_correction += h->slen;
293 /* Flush and check for any errors while writing */
295 if (fflush(f) != 0 || ferror(f))
296 return spool_write_error(where, errmsg, US"write", temp_name, f);
298 /* Force the file's contents to be written to disk. Note that fflush()
299 just pushes it out of C, and fclose() doesn't guarantee to do the write
300 either. That's just the way Unix works... */
302 if (EXIMfsync(fileno(f)) < 0)
303 return spool_write_error(where, errmsg, US"sync", temp_name, f);
305 /* Get the size of the file, and close it. */
309 return spool_write_error(where, errmsg, US"close", temp_name, NULL);
311 /* Rename the file to its correct name, thereby replacing any previous
314 sprintf(CS name, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
316 if (Urename(temp_name, name) < 0)
317 return spool_write_error(where, errmsg, US"rename", temp_name, NULL);
319 /* Linux (and maybe other OS?) does not automatically sync a directory after
320 an operation like rename. We therefore have to do it forcibly ourselves in
321 these cases, to make sure the file is actually accessible on disk, as opposed
322 to just the data being accessible from a file in lost+found. Linux also has
323 O_DIRECTORY, for opening a directory.
325 However, it turns out that some file systems (some versions of NFS?) do not
326 support directory syncing. It seems safe enough to ignore EINVAL to cope with
327 these cases. One hack on top of another... but that's life. */
329 #ifdef NEED_SYNC_DIRECTORY
331 sprintf(CS temp_name, "%s/input/%s/.", spool_directory, message_subdir);
334 #define O_DIRECTORY 0
337 if ((fd = Uopen(temp_name, O_RDONLY|O_DIRECTORY, 0)) < 0)
338 return spool_write_error(where, errmsg, US"directory open", name, NULL);
340 if (EXIMfsync(fd) < 0 && errno != EINVAL)
341 return spool_write_error(where, errmsg, US"directory sync", name, NULL);
344 return spool_write_error(where, errmsg, US"directory close", name, NULL);
346 #endif /* NEED_SYNC_DIRECTORY */
348 /* Return the number of characters in the headers, which is the file size, less
349 the prelimary stuff, less the additional count fields on the headers. */
351 DEBUG(D_receive) debug_printf("Size of headers = %d\n",
352 (int)(statbuf.st_size - size_correction));
354 return statbuf.st_size - size_correction;
358 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
360 /************************************************
362 ************************************************/
364 /* Used by spool_move_message() below. Note re the use of sprintf(): the value
365 of spool_directory is checked to ensure that it is less than 200 characters at
369 dir base directory name
370 subdir subdirectory name
372 suffix suffix to add to id
373 from source directory prefix
374 to destination directory prefix
375 noentok if TRUE, absence of file is not an error
377 Returns: TRUE if all went well
378 FALSE, having panic logged if not
382 make_link(uschar *dir, uschar *subdir, uschar *id, uschar *suffix, uschar *from,
383 uschar *to, BOOL noentok)
385 uschar f[256], t[256];
386 sprintf(CS f, "%s/%s%s/%s/%s%s", spool_directory, from, dir, subdir, id, suffix);
387 sprintf(CS t, "%s/%s%s/%s/%s%s", spool_directory, to, dir, subdir, id, suffix);
388 if (Ulink(f, t) < 0 && (!noentok || errno != ENOENT))
390 log_write(0, LOG_MAIN|LOG_PANIC, "link(\"%s\", \"%s\") failed while moving "
391 "message: %s", f, t, strerror(errno));
399 /************************************************
401 ************************************************/
403 /* Used by spool_move_message() below. Note re the use of sprintf(): the value
404 of spool_directory is checked to ensure that it is less than 200 characters at
408 dir base directory name
409 subdir subdirectory name
411 suffix suffix to add to id
412 from source directory prefix
413 noentok if TRUE, absence of file is not an error
415 Returns: TRUE if all went well
416 FALSE, having panic logged if not
420 break_link(uschar *dir, uschar *subdir, uschar *id, uschar *suffix, uschar *from,
424 sprintf(CS f, "%s/%s%s/%s/%s%s", spool_directory, from, dir, subdir, id, suffix);
425 if (Uunlink(f) < 0 && (!noentok || errno != ENOENT))
427 log_write(0, LOG_MAIN|LOG_PANIC, "unlink(\"%s\") failed while moving "
428 "message: %s", f, strerror(errno));
436 /************************************************
437 * Move message files *
438 ************************************************/
440 /* Move the files for a message (-H, -D, and msglog) from one directory (or
441 hierarchy) to another. It is assume that there is no -J file in existence when
442 this is done. At present, this is used only when move_frozen_messages is set,
443 so compile it only when that support is configured.
446 id the id of the message to be delivered
447 subdir the subdirectory name, or an empty string
448 from a prefix for "input" or "msglog" for where the message is now
449 to a prefix for "input" or "msglog" for where the message is to go
451 Returns: TRUE if all is well
452 FALSE if not, with error logged in panic and main logs
456 spool_move_message(uschar *id, uschar *subdir, uschar *from, uschar *to)
458 /* Create any output directories that do not exist. */
460 sprintf(CS big_buffer, "%sinput/%s", to, subdir);
461 (void)directory_make(spool_directory, big_buffer, INPUT_DIRECTORY_MODE, TRUE);
462 sprintf(CS big_buffer, "%smsglog/%s", to, subdir);
463 (void)directory_make(spool_directory, big_buffer, INPUT_DIRECTORY_MODE, TRUE);
465 /* Move the message by first creating new hard links for all the files, and
466 then removing the old links. When moving messages onto the main spool, the -H
467 file should be set up last, because that's the one that tells Exim there is a
468 message to be delivered, so we create its new link last and remove its old link
469 first. Programs that look at the alternate directories should follow the same
470 rule of waiting for a -H file before doing anything. When moving messsages off
471 the mail spool, the -D file should be open and locked at the time, thus keeping
474 if (!make_link(US"msglog", subdir, id, US"", from, to, TRUE) ||
475 !make_link(US"input", subdir, id, US"-D", from, to, FALSE) ||
476 !make_link(US"input", subdir, id, US"-H", from, to, FALSE))
479 if (!break_link(US"input", subdir, id, US"-H", from, FALSE) ||
480 !break_link(US"input", subdir, id, US"-D", from, FALSE) ||
481 !break_link(US"msglog", subdir, id, US"", from, TRUE))
484 log_write(0, LOG_MAIN, "moved from %sinput, %smsglog to %sinput, %smsglog",
492 /* End of spool_out.c */