-/* $Cambridge: exim/src/src/spool_mbox.c,v 1.8 2005/07/01 10:49:02 ph10 Exp $ */
-
/*************************************************
* Exim - an Internet mail transport agent *
*************************************************/
-/* Copyright (c) Tom Kistner <tom@duncanthrax.net> 2003-???? */
-/* License: GPL */
+/*
+ * Copyright (c) The Exim Maintainers 2016 - 2023
+ * Copyright (c) Tom Kistner <tom@duncanthrax.net> 2003 - 2015
+ * License: GPL
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
/* Code for setting up a MBOX style spool file inside a /scan/<msgid>
sub directory of exim's spool directory. */
#include "exim.h"
#ifdef WITH_CONTENT_SCAN
-/* externals, we must reset them on unspooling */
-#ifdef WITH_OLD_DEMIME
-extern int demime_ok;
-extern struct file_extension *file_extensions;
-#endif
-
extern int malware_ok;
extern int spam_ok;
int spool_mbox_ok = 0;
-uschar spooled_message_id[17];
-
-/* returns a pointer to the FILE, and puts the size in bytes into mbox_file_size */
-
-FILE *spool_mbox(unsigned long *mbox_file_size) {
- uschar mbox_path[1024];
- uschar message_subdir[2];
- uschar data_buffer[65535];
- FILE *mbox_file;
- FILE *data_file = NULL;
- header_line *my_headerlist;
- struct stat statbuf;
- int i,j;
- uschar *mbox_delimiter;
- uschar *envelope_from;
- uschar *envelope_to;
-
- if (!spool_mbox_ok) {
- /* create scan directory, if not present */
- if (!directory_make(spool_directory, US "scan", 0750, FALSE)) {
- debug_printf("unable to create directory: %s/scan\n", spool_directory);
- return NULL;
- };
-
- /* create temp directory inside scan dir */
- snprintf(CS mbox_path, 1024, "%s/scan/%s", spool_directory, message_id);
- if (!directory_make(NULL, mbox_path, 0750, FALSE)) {
- debug_printf("unable to create directory: %s/scan/%s\n", spool_directory, message_id);
- return NULL;
- };
-
- /* open [message_id].eml file for writing */
- snprintf(CS mbox_path, 1024, "%s/scan/%s/%s.eml", spool_directory, message_id, message_id);
- mbox_file = Ufopen(mbox_path,"wb");
-
- if (mbox_file == NULL) {
- debug_printf("unable to open file for writing: %s\n", mbox_path);
- return NULL;
- };
-
- /* Generate mailbox delimiter */
- mbox_delimiter = expand_string(US"From ${sender_address} ${tod_bsdinbox}\n");
- if (mbox_delimiter != NULL) {
- if (mbox_delimiter[0] != 0) {
- i = fwrite(mbox_delimiter, 1, Ustrlen(mbox_delimiter), mbox_file);
- if (i != Ustrlen(mbox_delimiter)) {
- debug_printf("error/short write on writing in: %s", mbox_path);
- (void)fclose(mbox_file);
- return NULL;
- };
- };
- };
- /* Generate X-Envelope-From header */
- envelope_from = expand_string(US"${sender_address}");
- if (envelope_from != NULL) {
- if (envelope_from[0] != 0) {
- uschar *my_envelope_from;
- my_envelope_from = string_sprintf("X-Envelope-From: <%s>\n", envelope_from);
- i = fwrite(my_envelope_from, 1, Ustrlen(my_envelope_from), mbox_file);
- if (i != Ustrlen(my_envelope_from)) {
- debug_printf("error/short write on writing in: %s", mbox_path);
- (void)fclose(mbox_file);
- return NULL;
- };
- };
- };
- /* Generate X-Envelope-To header */
- envelope_to = expand_string(US"${if def:received_for{$received_for}}");
- if (envelope_to != NULL) {
- if (envelope_to[0] != 0) {
- uschar *my_envelope_to;
- my_envelope_to = string_sprintf("X-Envelope-To: <%s>\n", envelope_to);
- i = fwrite(my_envelope_to, 1, Ustrlen(my_envelope_to), mbox_file);
- if (i != Ustrlen(my_envelope_to)) {
- debug_printf("error/short write on writing in: %s", mbox_path);
- (void)fclose(mbox_file);
- return NULL;
- };
- };
- };
-
- /* write all header lines to mbox file */
- my_headerlist = header_list;
- while (my_headerlist != NULL) {
-
- /* skip deleted headers */
- if (my_headerlist->type == '*') {
- my_headerlist = my_headerlist->next;
- continue;
- };
-
- i = fwrite(my_headerlist->text, 1, my_headerlist->slen, mbox_file);
- if (i != my_headerlist->slen) {
- debug_printf("error/short write on writing in: %s", mbox_path);
- (void)fclose(mbox_file);
- return NULL;
- };
-
- my_headerlist = my_headerlist->next;
- };
-
- /* copy body file */
- message_subdir[1] = '\0';
- for (i = 0; i < 2; i++) {
- message_subdir[0] = (split_spool_directory == (i == 0))? message_id[5] : 0;
- sprintf(CS mbox_path, "%s/input/%s/%s-D", spool_directory, message_subdir, message_id);
- data_file = Ufopen(mbox_path,"rb");
- if (data_file != NULL)
- break;
- };
-
- (void)fread(data_buffer, 1, 18, data_file);
-
- do {
- j = fread(data_buffer, 1, sizeof(data_buffer), data_file);
- if (j > 0) {
- i = fwrite(data_buffer, 1, j, mbox_file);
- if (i != j) {
- debug_printf("error/short write on writing in: %s", mbox_path);
- (void)fclose(mbox_file);
- (void)fclose(data_file);
- return NULL;
- };
- };
+uschar spooled_message_id[MESSAGE_ID_LENGTH+1];
+
+/*
+Create an MBOX-style message file from the spooled files.
+
+Returns a pointer to the FILE, and puts the size in bytes into mbox_file_size.
+If mbox_fname is non-null, fill in a pointer to the name.
+Normally, source_file_override is NULL
+*/
+
+FILE *
+spool_mbox(unsigned long *mbox_file_size, const uschar *source_file_override,
+ uschar ** mbox_fname)
+{
+uschar message_subdir[2];
+uschar buffer[16384];
+uschar *temp_string;
+uschar *mbox_path;
+FILE *mbox_file = NULL, *l_data_file = NULL, *yield = NULL;
+struct stat statbuf;
+int j;
+rmark reset_point;
+
+mbox_path = string_sprintf("%s/scan/%s/%s.eml",
+ spool_directory, message_id, message_id);
+if (mbox_fname) *mbox_fname = mbox_path;
+
+reset_point = store_mark();
+
+/* Skip creation if already spooled out as mbox file */
+if (!spool_mbox_ok)
+ {
+ /* create temp directory inside scan dir, directory_make works recursively */
+ temp_string = string_sprintf("scan/%s", message_id);
+ if (!directory_make(spool_directory, temp_string, 0750, FALSE))
+ {
+ log_write(0, LOG_MAIN|LOG_PANIC, "%s",
+ string_open_failed("scan directory %s/scan/%s", spool_directory, temp_string));
+ goto OUT;
+ }
+
+ /* open [message_id].eml file for writing */
+
+ if (!(mbox_file = modefopen(mbox_path, "wb", SPOOL_MODE)))
+ {
+ log_write(0, LOG_MAIN|LOG_PANIC, "%s",
+ string_open_failed("scan file %s", mbox_path));
+ goto OUT;
+ }
+
+ /* Generate mailbox headers. The $received_for variable is (up to at least
+ Exim 4.64) never set here, because it is only set when expanding the
+ contents of the Received: header line. However, the code below will use it
+ if it should become available in future. */
+
+ temp_string = expand_string(
+ US"From ${if def:return_path{$return_path}{MAILER-DAEMON}} ${tod_bsdinbox}\n"
+ "${if def:sender_address{X-Envelope-From: <${sender_address}>\n}}"
+ "${if def:recipients{X-Envelope-To: ${recipients}\n}}");
+
+ if (temp_string)
+ if (fwrite(temp_string, Ustrlen(temp_string), 1, mbox_file) != 1)
+ {
+ log_write(0, LOG_MAIN|LOG_PANIC, "Error/short write while writing \
+ mailbox headers to %s", mbox_path);
+ goto OUT;
+ }
+
+ /* write all non-deleted header lines to mbox file */
+
+ for (header_line * my_headerlist = header_list; my_headerlist;
+ my_headerlist = my_headerlist->next)
+ if (my_headerlist->type != '*')
+ if (fwrite(my_headerlist->text, my_headerlist->slen, 1, mbox_file) != 1)
+ {
+ log_write(0, LOG_MAIN|LOG_PANIC, "Error/short write while writing \
+ message headers to %s", mbox_path);
+ goto OUT;
+ }
+
+ /* End headers */
+
+ if (fwrite("\n", 1, 1, mbox_file) != 1)
+ {
+ log_write(0, LOG_MAIN|LOG_PANIC, "Error/short write while writing \
+ message headers to %s", mbox_path);
+ goto OUT;
+ }
+
+ /* Copy body file. If the main receive still has it open then it is holding
+ a lock, and we must not close it (which releases the lock), so just use the
+ global file handle. */
+
+ if (source_file_override)
+ l_data_file = Ufopen(source_file_override, "rb");
+ else if (spool_data_file)
+ l_data_file = spool_data_file;
+ else
+ for (int i = 0; i < 2; i++)
+ {
+ set_subdir_str(message_subdir, message_id, i);
+ temp_string = spool_fname(US"input", message_subdir, message_id, US"-D");
+ if ((l_data_file = Ufopen(temp_string, "rb"))) break;
+ }
+
+ if (!l_data_file)
+ {
+ log_write(0, LOG_MAIN|LOG_PANIC, "Could not open datafile for message %s",
+ message_id);
+ goto OUT;
+ }
+
+ /* The code used to use this line, but it doesn't work in Cygwin.
+
+ (void)fread(data_buffer, 1, 18, l_data_file);
+
+ What's happening is that spool_mbox used to use an fread to jump over the
+ file header. That fails under Cygwin because the header is locked, but
+ doing an fseek succeeds. We have to output the leading newline
+ explicitly, because the one in the file is parted of the locked area. */
+
+ if (!source_file_override)
+ (void)fseek(l_data_file, spool_data_start_offset(message_id), SEEK_SET);
+
+ do
+ {
+ uschar * s;
+
+ if (!f.spool_file_wireformat || source_file_override)
+ j = fread(buffer, 1, sizeof(buffer), l_data_file);
+ else /* needs CRLF -> NL */
+ if ((s = US fgets(CS buffer, sizeof(buffer), l_data_file)))
+ {
+ uschar * p = s + Ustrlen(s) - 1;
+
+ if (*p == '\n' && p[-1] == '\r')
+ *--p = '\n';
+ else if (*p == '\r')
+ ungetc(*p--, l_data_file);
+
+ j = p - buffer;
+ }
+ else
+ j = 0;
+
+ if (j > 0)
+ if (fwrite(buffer, j, 1, mbox_file) != 1)
+ {
+ log_write(0, LOG_MAIN|LOG_PANIC, "Error/short write while writing \
+ message body to %s", mbox_path);
+ goto OUT;
+ }
} while (j > 0);
- (void)fclose(data_file);
- (void)fclose(mbox_file);
- Ustrcpy(spooled_message_id, message_id);
- spool_mbox_ok = 1;
- };
+ (void)fclose(mbox_file);
+ mbox_file = NULL;
- snprintf(CS mbox_path, 1024, "%s/scan/%s/%s.eml", spool_directory, message_id, message_id);
+ Ustrncpy(spooled_message_id, message_id, sizeof(spooled_message_id));
+ spooled_message_id[sizeof(spooled_message_id)-1] = '\0';
+ spool_mbox_ok = 1;
+ }
- /* get the size of the mbox message */
- stat(CS mbox_path, &statbuf);
- *mbox_file_size = statbuf.st_size;
+/* get the size of the mbox message and open [message_id].eml file for reading*/
- /* open [message_id].eml file for reading */
- mbox_file = Ufopen(mbox_path,"rb");
+if ( !(yield = Ufopen(mbox_path,"rb"))
+ || fstat(fileno(yield), &statbuf) != 0
+ )
+ log_write(0, LOG_MAIN|LOG_PANIC, "%s",
+ string_open_failed( "scan file %s", mbox_path));
+else
+ *mbox_file_size = statbuf.st_size;
- return mbox_file;
+OUT:
+if (l_data_file && !spool_data_file) (void)fclose(l_data_file);
+if (mbox_file) (void)fclose(mbox_file);
+store_reset(reset_point);
+return yield;
}
-/* remove mbox spool file, demimed files and temp directory */
-void unspool_mbox(void) {
-
- /* reset all exiscan state variables */
- #ifdef WITH_OLD_DEMIME
- demime_ok = 0;
- demime_errorlevel = 0;
- demime_reason = NULL;
- file_extensions = NULL;
- #endif
- spam_ok = 0;
- malware_ok = 0;
- if (spool_mbox_ok) {
- spool_mbox_ok = 0;
- if (!no_mbox_unspool) {
- uschar mbox_path[1024];
- uschar file_path[1024];
- int n;
- struct dirent *entry;
- DIR *tempdir;
+/* remove mbox spool file and temp directory */
+void
+unspool_mbox(void)
+{
+spam_ok = 0;
+malware_ok = 0;
- snprintf(CS mbox_path, 1024, "%s/scan/%s", spool_directory, spooled_message_id);
+if (spool_mbox_ok && !f.no_mbox_unspool)
+ {
+ uschar *file_path;
+ DIR *tempdir;
+ rmark reset_point = store_mark();
+ uschar * mbox_path = string_sprintf("%s/scan/%s", spool_directory, spooled_message_id);
- tempdir = opendir(CS mbox_path);
+ if (!(tempdir = exim_opendir(mbox_path)))
+ {
+ debug_printf("Unable to opendir(%s): %s\n", mbox_path, strerror(errno));
+ /* Just in case we still can: */
+ (void) rmdir(CS mbox_path);
+ return;
+ }
/* loop thru dir & delete entries */
- n = 0;
- do {
- entry = readdir(tempdir);
- if (entry == NULL) break;
- snprintf(CS file_path, 1024,"%s/scan/%s/%s", spool_directory, spooled_message_id, entry->d_name);
- if ( (Ustrcmp(entry->d_name,"..") != 0) && (Ustrcmp(entry->d_name,".") != 0) ) {
- debug_printf("unspool_mbox(): unlinking '%s'\n", file_path);
- n = unlink(CS file_path);
- };
- } while (n > -1);
+ for (struct dirent *entry; entry = readdir(tempdir); )
+ {
+ uschar *name = US entry->d_name;
+ if (Ustrcmp(name, US".") == 0 || Ustrcmp(name, US"..") == 0) continue;
+
+ file_path = string_sprintf("%s/%s", mbox_path, name);
+ debug_printf("unspool_mbox(): unlinking '%s'\n", file_path);
+ if (unlink(CS file_path) != 0)
+ log_write(0, LOG_MAIN|LOG_PANIC, "unlink(%s): %s", file_path, strerror(errno));
+ }
closedir(tempdir);
/* remove directory */
- n = rmdir(CS mbox_path);
- };
- };
+ if (rmdir(CS mbox_path) != 0)
+ log_write(0, LOG_MAIN|LOG_PANIC, "rmdir(%s): %s", mbox_path, strerror(errno));
+ store_reset(reset_point);
+ }
+spool_mbox_ok = 0;
}
#endif
git://git.exim.org / exim.git / blobdiff