X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-insert.c;h=7074077ca699ea8d63cdcf8bdee0cbc59e19014f;hp=6752fc8de25531a161cd6d119518c2d9cc338cf5;hb=4e2c351c588ad74f4800ca0344232be90387c54a;hpb=e8ec38c25afefacff8c2adb6e4f9e53df9870746

diff --git a/notmuch-insert.c b/notmuch-insert.c
index 6752fc8d..7074077c 100644
--- a/notmuch-insert.c
+++ b/notmuch-insert.c
@@ -67,26 +67,30 @@ safe_gethostname (char *hostname, size_t len)
 static notmuch_bool_t
 sync_dir (const char *dir)
 {
-    notmuch_bool_t ret;
-    int fd;
+    int fd, r;
 
     fd = open (dir, O_RDONLY);
     if (fd == -1) {
-	fprintf (stderr, "Error: open() dir failed: %s\n", strerror (errno));
+	fprintf (stderr, "Error: open %s: %s\n", dir, strerror (errno));
 	return FALSE;
     }
-    ret = (fsync (fd) == 0);
-    if (! ret) {
-	fprintf (stderr, "Error: fsync() dir failed: %s\n", strerror (errno));
-    }
+
+    r = fsync (fd);
+    if (r)
+	fprintf (stderr, "Error: fsync %s: %s\n", dir, strerror (errno));
+
     close (fd);
-    return ret;
+
+    return r == 0;
 }
 
-/* Check the specified folder name does not contain a directory
- * component ".." to prevent writes outside of the Maildir hierarchy. */
+/*
+ * Check the specified folder name does not contain a directory
+ * component ".." to prevent writes outside of the Maildir
+ * hierarchy. Return TRUE on valid folder name, FALSE otherwise.
+ */
 static notmuch_bool_t
-check_folder_name (const char *folder)
+is_valid_folder_name (const char *folder)
 {
     const char *p = folder;
 
@@ -100,159 +104,147 @@ check_folder_name (const char *folder)
     }
 }
 
-/* Make the given directory, succeeding if it already exists. */
+/*
+ * Make the given directory and its parents as necessary, using the
+ * given mode. Return TRUE on success, FALSE otherwise. Partial
+ * results are not cleaned up on errors.
+ */
 static notmuch_bool_t
-make_directory (char *path, int mode)
+mkdir_recursive (const void *ctx, const char *path, int mode)
 {
-    notmuch_bool_t ret;
-    char *slash;
+    struct stat st;
+    int r;
+    char *parent = NULL, *slash;
 
-    if (mkdir (path, mode) != 0)
-	return (errno == EEXIST);
+    /* First check the common case: directory already exists. */
+    r = stat (path, &st);
+    if (r == 0) {
+        if (! S_ISDIR (st.st_mode)) {
+	    fprintf (stderr, "Error: '%s' is not a directory: %s\n",
+		     path, strerror (EEXIST));
+	    return FALSE;
+	}
 
-    /* Sync the parent directory for durability. */
-    ret = TRUE;
-    slash = strrchr (path, '/');
-    if (slash) {
-	*slash = '\0';
-	ret = sync_dir (path);
-	*slash = '/';
+	return TRUE;
+    } else if (errno != ENOENT) {
+	fprintf (stderr, "Error: stat '%s': %s\n", path, strerror (errno));
+	return FALSE;
     }
-    return ret;
-}
-
-/* Make the given directory including its parent directories as necessary.
- * Return TRUE on success, FALSE on error. */
-static notmuch_bool_t
-make_directory_and_parents (char *path, int mode)
-{
-    struct stat st;
-    char *start;
-    char *end;
-    notmuch_bool_t ret;
 
-    /* First check the common case: directory already exists. */
-    if (stat (path, &st) == 0)
-	return S_ISDIR (st.st_mode) ? TRUE : FALSE;
-
-    for (start = path; *start != '\0'; start = end + 1) {
-	/* start points to the first unprocessed character.
-	 * Find the next slash from start onwards. */
-	end = strchr (start, '/');
-
-	/* If there are no more slashes then all the parent directories
-	 * have been made.  Now attempt to make the whole path. */
-	if (end == NULL)
-	    return make_directory (path, mode);
-
-	/* Make the path up to the next slash, unless the current
-	 * directory component is actually empty. */
-	if (end > start) {
-	    *end = '\0';
-	    ret = make_directory (path, mode);
-	    *end = '/';
-	    if (! ret)
-		return FALSE;
+    /* mkdir parents, if any */
+    slash = strrchr (path, '/');
+    if (slash && slash != path) {
+	parent = talloc_strndup (ctx, path, slash - path);
+	if (! parent) {
+	    fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
+	    return FALSE;
 	}
+
+	if (! mkdir_recursive (ctx, parent, mode))
+	    return FALSE;
     }
 
-    return TRUE;
+    if (mkdir (path, mode)) {
+	fprintf (stderr, "Error: mkdir '%s': %s\n", path, strerror (errno));
+	return FALSE;
+    }
+
+    return parent ? sync_dir (parent) : TRUE;
 }
 
-/* Create the given maildir folder, i.e. dir and its subdirectories
- * 'cur', 'new', 'tmp'. */
+/*
+ * Create the given maildir folder, i.e. maildir and its
+ * subdirectories cur/new/tmp. Return TRUE on success, FALSE
+ * otherwise. Partial results are not cleaned up on errors.
+ */
 static notmuch_bool_t
-maildir_create_folder (void *ctx, const char *dir)
+maildir_create_folder (const void *ctx, const char *maildir)
 {
+    const char *subdirs[] = { "cur", "new", "tmp" };
     const int mode = 0700;
     char *subdir;
-    char *tail;
-
-    /* Create 'cur' directory, including parent directories. */
-    subdir = talloc_asprintf (ctx, "%s/cur", dir);
-    if (! subdir) {
-	fprintf (stderr, "Out of memory.\n");
-	return FALSE;
-    }
-    if (! make_directory_and_parents (subdir, mode))
-	return FALSE;
-
-    tail = subdir + strlen (subdir) - 3;
+    unsigned int i;
 
-    /* Create 'new' directory. */
-    strcpy (tail, "new");
-    if (! make_directory (subdir, mode))
-	return FALSE;
+    for (i = 0; i < ARRAY_SIZE (subdirs); i++) {
+	subdir = talloc_asprintf (ctx, "%s/%s", maildir, subdirs[i]);
+	if (! subdir) {
+	    fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
+	    return FALSE;
+	}
 
-    /* Create 'tmp' directory. */
-    strcpy (tail, "tmp");
-    if (! make_directory (subdir, mode))
-	return FALSE;
+	if (! mkdir_recursive (ctx, subdir, mode))
+	    return FALSE;
+    }
 
-    talloc_free (subdir);
     return TRUE;
 }
 
-/* Open a unique file in the 'tmp' sub-directory of dir.
- * Returns the file descriptor on success, or -1 on failure.
- * On success, file paths for the message in the 'tmp' and 'new'
- * directories are returned via tmppath and newpath,
- * and the path of the 'new' directory itself in newdir. */
-static int
-maildir_open_tmp_file (void *ctx, const char *dir,
-		       char **tmppath, char **newpath, char **newdir)
+/*
+ * Generate a temporary file basename, no path, do not create an
+ * actual file. Return the basename, or NULL on errors.
+ */
+static char *
+tempfilename (const void *ctx)
 {
-    pid_t pid;
+    char *filename;
     char hostname[256];
     struct timeval tv;
-    char *filename;
-    int fd = -1;
+    pid_t pid;
 
     /* We follow the Dovecot file name generation algorithm. */
     pid = getpid ();
     safe_gethostname (hostname, sizeof (hostname));
+    gettimeofday (&tv, NULL);
+
+    filename = talloc_asprintf (ctx, "%ld.M%ldP%d.%s",
+				tv.tv_sec, tv.tv_usec, pid, hostname);
+    if (! filename)
+	fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
+
+    return filename;
+}
+
+/*
+ * Create a unique temporary file in maildir/tmp, return fd and full
+ * path to file in *path_out, or -1 on errors (in which case *path_out
+ * is not touched).
+ */
+static int
+maildir_mktemp (const void *ctx, const char *maildir, char **path_out)
+{
+    char *filename, *path;
+    int fd;
+
     do {
-	gettimeofday (&tv, NULL);
-	filename = talloc_asprintf (ctx, "%ld.M%ldP%d.%s",
-				    tv.tv_sec, tv.tv_usec, pid, hostname);
-	if (! filename) {
-	    fprintf (stderr, "Out of memory\n");
+	filename = tempfilename (ctx);
+	if (! filename)
 	    return -1;
-	}
 
-	*tmppath = talloc_asprintf (ctx, "%s/tmp/%s", dir, filename);
-	if (! *tmppath) {
-	    fprintf (stderr, "Out of memory\n");
+	path = talloc_asprintf (ctx, "%s/tmp/%s", maildir, filename);
+	if (! path) {
+	    fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
 	    return -1;
 	}
 
-	fd = open (*tmppath, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0600);
+	fd = open (path, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0600);
     } while (fd == -1 && errno == EEXIST);
 
     if (fd == -1) {
-	fprintf (stderr, "Error: opening %s: %s\n", *tmppath, strerror (errno));
+	fprintf (stderr, "Error: open '%s': %s\n", path, strerror (errno));
 	return -1;
     }
 
-    *newdir = talloc_asprintf (ctx, "%s/new", dir);
-    *newpath = talloc_asprintf (ctx, "%s/new/%s", dir, filename);
-    if (! *newdir || ! *newpath) {
-	fprintf (stderr, "Out of memory\n");
-	close (fd);
-	unlink (*tmppath);
-	return -1;
-    }
-
-    talloc_free (filename);
+    *path_out = path;
 
     return fd;
 }
 
-/* Copy the contents of standard input (fdin) into fdout.
- * Returns TRUE if a non-empty file was written successfully.
- * Otherwise, return FALSE. */
+/*
+ * Copy fdin to fdout, return TRUE on success, and FALSE on errors and
+ * empty input.
+ */
 static notmuch_bool_t
-copy_stdin (int fdin, int fdout)
+copy_fd (int fdout, int fdin)
 {
     notmuch_bool_t empty = TRUE;
 
@@ -291,111 +283,167 @@ copy_stdin (int fdin, int fdout)
     return (!interrupted && !empty);
 }
 
-/* Add the specified message file to the notmuch database, applying tags.
- * The file is renamed to encode notmuch tags as maildir flags. */
-static void
-add_file_to_database (notmuch_database_t *notmuch, const char *path,
-		      tag_op_list_t *tag_ops, notmuch_bool_t synchronize_flags)
+/*
+ * Write fdin to a new temp file in maildir/tmp, return full path to
+ * the file, or NULL on errors.
+ */
+static char *
+maildir_write_tmp (const void *ctx, int fdin, const char *maildir)
 {
-    notmuch_message_t *message;
-    notmuch_status_t status;
+    char *path;
+    int fdout;
 
-    status = notmuch_database_add_message (notmuch, path, &message);
-    switch (status) {
-    case NOTMUCH_STATUS_SUCCESS:
-    case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
-	break;
-    default:
-    case NOTMUCH_STATUS_FILE_NOT_EMAIL:
-    case NOTMUCH_STATUS_READ_ONLY_DATABASE:
-    case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
-    case NOTMUCH_STATUS_OUT_OF_MEMORY:
-    case NOTMUCH_STATUS_FILE_ERROR:
-    case NOTMUCH_STATUS_NULL_POINTER:
-    case NOTMUCH_STATUS_TAG_TOO_LONG:
-    case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
-    case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
-    case NOTMUCH_STATUS_LAST_STATUS:
-	fprintf (stderr, "Error: failed to add `%s' to notmuch database: %s\n",
-		 path, notmuch_status_to_string (status));
-	return;
-    }
+    fdout = maildir_mktemp (ctx, maildir, &path);
+    if (fdout < 0)
+	return NULL;
 
-    if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
-	/* Don't change tags of an existing message. */
-	if (synchronize_flags) {
-	    status = notmuch_message_tags_to_maildir_flags (message);
-	    if (status != NOTMUCH_STATUS_SUCCESS)
-		fprintf (stderr, "Error: failed to sync tags to maildir flags\n");
-	}
-    } else {
-	tag_op_flag_t flags = synchronize_flags ? TAG_FLAG_MAILDIR_SYNC : 0;
+    if (! copy_fd (fdout, fdin))
+	goto FAIL;
 
-	tag_op_list_apply (message, tag_ops, flags);
+    if (fsync (fdout)) {
+	fprintf (stderr, "Error: fsync '%s': %s\n", path, strerror (errno));
+	goto FAIL;
     }
 
-    notmuch_message_destroy (message);
+    close (fdout);
+
+    return path;
+
+FAIL:
+    close (fdout);
+    unlink (path);
+
+    return NULL;
 }
 
-static notmuch_bool_t
-insert_message (void *ctx, notmuch_database_t *notmuch, int fdin,
-		const char *dir, tag_op_list_t *tag_ops,
-		notmuch_bool_t synchronize_flags)
+/*
+ * Write fdin to a new file in maildir/new, using an intermediate temp
+ * file in maildir/tmp, return full path to the new file, or NULL on
+ * errors.
+ */
+static char *
+maildir_write_new (const void *ctx, int fdin, const char *maildir)
 {
-    char *tmppath;
-    char *newpath;
-    char *newdir;
-    int fdout;
-    char *cleanup_path;
-
-    fdout = maildir_open_tmp_file (ctx, dir, &tmppath, &newpath, &newdir);
-    if (fdout < 0)
-	return FALSE;
+    char *cleanpath, *tmppath, *newpath, *newdir;
 
-    cleanup_path = tmppath;
+    tmppath = maildir_write_tmp (ctx, fdin, maildir);
+    if (! tmppath)
+	return NULL;
+    cleanpath = tmppath;
 
-    if (! copy_stdin (fdin, fdout))
+    newpath = talloc_strdup (ctx, tmppath);
+    if (! newpath) {
+	fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
 	goto FAIL;
+    }
+
+    /* sanity checks needed? */
+    memcpy (newpath + strlen (maildir) + 1, "new", 3);
 
-    if (fsync (fdout) != 0) {
-	fprintf (stderr, "Error: fsync failed: %s\n", strerror (errno));
+    if (rename (tmppath, newpath)) {
+	fprintf (stderr, "Error: rename '%s' '%s': %s\n",
+		 tmppath, newpath, strerror (errno));
 	goto FAIL;
     }
+    cleanpath = newpath;
 
-    close (fdout);
-    fdout = -1;
-
-    /* Atomically move the new message file from the Maildir 'tmp' directory
-     * to the 'new' directory.  We follow the Dovecot recommendation to
-     * simply use rename() instead of link() and unlink().
-     * See also: http://wiki.dovecot.org/MailboxFormat/Maildir#Mail_delivery
-     */
-    if (rename (tmppath, newpath) != 0) {
-	fprintf (stderr, "Error: rename() failed: %s\n", strerror (errno));
+    newdir = talloc_asprintf (ctx, "%s/%s", maildir, "new");
+    if (! newdir) {
+	fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
 	goto FAIL;
     }
 
-    cleanup_path = newpath;
-
     if (! sync_dir (newdir))
 	goto FAIL;
 
-    /* Even if adding the message to the notmuch database fails,
-     * the message is on disk and we consider the delivery completed. */
-    add_file_to_database (notmuch, newpath, tag_ops, synchronize_flags);
+    return newpath;
 
-    return TRUE;
+FAIL:
+    unlink (cleanpath);
+
+    return NULL;
+}
+
+/*
+ * Add the specified message file to the notmuch database, applying
+ * tags in tag_ops. If synchronize_flags is TRUE, the tags are
+ * synchronized to maildir flags (which may result in message file
+ * rename).
+ *
+ * Return NOTMUCH_STATUS_SUCCESS on success, errors otherwise. If keep
+ * is TRUE, errors in tag changes and flag syncing are ignored and
+ * success status is returned; otherwise such errors cause the message
+ * to be removed from the database. Failure to add the message to the
+ * database results in error status regardless of keep.
+ */
+static notmuch_status_t
+add_file (notmuch_database_t *notmuch, const char *path, tag_op_list_t *tag_ops,
+	  notmuch_bool_t synchronize_flags, notmuch_bool_t keep)
+{
+    notmuch_message_t *message;
+    notmuch_status_t status;
+
+    status = notmuch_database_add_message (notmuch, path, &message);
+    if (status == NOTMUCH_STATUS_SUCCESS) {
+	status = tag_op_list_apply (message, tag_ops, 0);
+	if (status) {
+	    fprintf (stderr, "%s: failed to apply tags to file '%s': %s\n",
+		     keep ? "Warning" : "Error",
+		     path, notmuch_status_to_string (status));
+	    goto DONE;
+	}
+    } else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
+	status = NOTMUCH_STATUS_SUCCESS;
+    } else if (status == NOTMUCH_STATUS_FILE_NOT_EMAIL) {
+	fprintf (stderr, "Error: delivery of non-mail file: '%s'\n", path);
+	goto FAIL;
+    } else {
+	fprintf (stderr, "Error: failed to add '%s' to notmuch database: %s\n",
+		 path, notmuch_status_to_string (status));
+	goto FAIL;
+    }
+
+    if (synchronize_flags) {
+	status = notmuch_message_tags_to_maildir_flags (message);
+	if (status != NOTMUCH_STATUS_SUCCESS)
+	    fprintf (stderr, "%s: failed to sync tags to maildir flags for '%s': %s\n",
+		     keep ? "Warning" : "Error",
+		     path, notmuch_status_to_string (status));
+
+	/*
+	 * Note: Unfortunately a failed maildir flag sync might
+	 * already have renamed the file, in which case the cleanup
+	 * path may fail.
+	 */
+    }
+
+  DONE:
+    notmuch_message_destroy (message);
+
+    if (status) {
+	if (keep) {
+	    status = NOTMUCH_STATUS_SUCCESS;
+	} else {
+	    notmuch_status_t cleanup_status;
+
+	    cleanup_status = notmuch_database_remove_message (notmuch, path);
+	    if (cleanup_status != NOTMUCH_STATUS_SUCCESS &&
+		cleanup_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
+		fprintf (stderr, "Warning: failed to remove '%s' from database "
+			 "after errors: %s. Please run 'notmuch new' to fix.\n",
+			 path, notmuch_status_to_string (cleanup_status));
+	    }
+	}
+    }
 
   FAIL:
-    if (fdout >= 0)
-	close (fdout);
-    unlink (cleanup_path);
-    return FALSE;
+    return status;
 }
 
 int
 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])
 {
+    notmuch_status_t status, close_status;
     notmuch_database_t *notmuch;
     struct sigaction action;
     const char *db_path;
@@ -405,15 +453,17 @@ notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])
     char *query_string = NULL;
     const char *folder = NULL;
     notmuch_bool_t create_folder = FALSE;
+    notmuch_bool_t keep = FALSE;
     notmuch_bool_t synchronize_flags;
     const char *maildir;
+    char *newpath;
     int opt_index;
     unsigned int i;
-    notmuch_bool_t ret;
 
     notmuch_opt_desc_t options[] = {
 	{ NOTMUCH_OPT_STRING, &folder, "folder", 0, 0 },
 	{ NOTMUCH_OPT_BOOLEAN, &create_folder, "create-folder", 0, 0 },
+	{ NOTMUCH_OPT_BOOLEAN, &keep, "keep", 0, 0 },
 	{ NOTMUCH_OPT_END, 0, 0, 0, 0 }
     };
 
@@ -456,8 +506,8 @@ notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])
     if (folder == NULL) {
 	maildir = db_path;
     } else {
-	if (! check_folder_name (folder)) {
-	    fprintf (stderr, "Error: bad folder name: %s\n", folder);
+	if (! is_valid_folder_name (folder)) {
+	    fprintf (stderr, "Error: invalid folder name: '%s'\n", folder);
 	    return EXIT_FAILURE;
 	}
 	maildir = talloc_asprintf (config, "%s/%s", db_path, folder);
@@ -465,11 +515,8 @@ notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])
 	    fprintf (stderr, "Out of memory\n");
 	    return EXIT_FAILURE;
 	}
-	if (create_folder && ! maildir_create_folder (config, maildir)) {
-	    fprintf (stderr, "Error: creating maildir %s: %s\n",
-		     maildir, strerror (errno));
+	if (create_folder && ! maildir_create_folder (config, maildir))
 	    return EXIT_FAILURE;
-	}
     }
 
     /* Setup our handler for SIGINT. We do not set SA_RESTART so that copying
@@ -484,10 +531,39 @@ notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])
 			       NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))
 	return EXIT_FAILURE;
 
-    ret = insert_message (config, notmuch, STDIN_FILENO, maildir, tag_ops,
-			  synchronize_flags);
+    /* Write the message to the Maildir new directory. */
+    newpath = maildir_write_new (config, STDIN_FILENO, maildir);
+    if (! newpath) {
+	notmuch_database_destroy (notmuch);
+	return EXIT_FAILURE;
+    }
+
+    /* Index the message. */
+    status = add_file (notmuch, newpath, tag_ops, synchronize_flags, keep);
+
+    /* Commit changes. */
+    close_status = notmuch_database_destroy (notmuch);
+    if (close_status) {
+	/* Hold on to the first error, if any. */
+	if (! status)
+	    status = close_status;
+	fprintf (stderr, "%s: failed to commit database changes: %s\n",
+		 keep ? "Warning" : "Error",
+		 notmuch_status_to_string (close_status));
+    }
 
-    notmuch_database_destroy (notmuch);
+    if (status) {
+	if (keep) {
+	    status = NOTMUCH_STATUS_SUCCESS;
+	} else {
+	    /* If maildir flag sync failed, this might fail. */
+	    if (unlink (newpath)) {
+		fprintf (stderr, "Warning: failed to remove '%s' from maildir "
+			 "after errors: %s. Please run 'notmuch new' to fix.\n",
+			 newpath, strerror (errno));
+	    }
+	}
+    }
 
-    return ret ? EXIT_SUCCESS : EXIT_FAILURE;
+    return status ? EXIT_FAILURE : EXIT_SUCCESS;
 }