X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-insert.c;h=1d3b015053deef8062c2f17a08d8cfe47231d9fe;hp=5ef6e66d86e25b809ecc9ea91f4706b75551cc12;hb=HEAD;hpb=0d597f6889fe29bf94658a1389b38c100154b72f diff --git a/notmuch-insert.c b/notmuch-insert.c index 5ef6e66d..e44607ad 100644 --- a/notmuch-insert.c +++ b/notmuch-insert.c @@ -16,7 +16,7 @@ * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see http://www.gnu.org/licenses/ . + * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Peter Wang */ @@ -27,13 +27,14 @@ #include #include #include +#include "string-util.h" static volatile sig_atomic_t interrupted; static void handle_sigint (unused (int sig)) { - static char msg[] = "Stopping... \n"; + static const char msg[] = "Stopping... \n"; /* This write is "opportunistic", so it's okay to ignore the * result. It is not required for correctness, and if it does @@ -64,7 +65,7 @@ safe_gethostname (char *hostname, size_t len) } /* Call fsync() on a directory path. */ -static notmuch_bool_t +static bool sync_dir (const char *dir) { int fd, r; @@ -72,7 +73,7 @@ sync_dir (const char *dir) fd = open (dir, O_RDONLY); if (fd == -1) { fprintf (stderr, "Error: open %s: %s\n", dir, strerror (errno)); - return FALSE; + return false; } r = fsync (fd); @@ -87,29 +88,29 @@ sync_dir (const char *dir) /* * 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. + * hierarchy. Return true on valid folder name, false otherwise. */ -static notmuch_bool_t +static bool is_valid_folder_name (const char *folder) { const char *p = folder; for (;;) { if ((p[0] == '.') && (p[1] == '.') && (p[2] == '\0' || p[2] == '/')) - return FALSE; + return false; p = strchr (p, '/'); - if (!p) - return TRUE; + if (! p) + return true; p++; } } /* * Make the given directory and its parents as necessary, using the - * given mode. Return TRUE on success, FALSE otherwise. Partial + * given mode. Return true on success, false otherwise. Partial * results are not cleaned up on errors. */ -static notmuch_bool_t +static bool mkdir_recursive (const void *ctx, const char *path, int mode) { struct stat st; @@ -119,16 +120,16 @@ mkdir_recursive (const void *ctx, const char *path, int mode) /* First check the common case: directory already exists. */ r = stat (path, &st); if (r == 0) { - if (! S_ISDIR (st.st_mode)) { + if (! S_ISDIR (st.st_mode)) { fprintf (stderr, "Error: '%s' is not a directory: %s\n", path, strerror (EEXIST)); - return FALSE; + return false; } - return TRUE; + return true; } else if (errno != ENOENT) { fprintf (stderr, "Error: stat '%s': %s\n", path, strerror (errno)); - return FALSE; + return false; } /* mkdir parents, if any */ @@ -137,31 +138,31 @@ mkdir_recursive (const void *ctx, const char *path, int mode) parent = talloc_strndup (ctx, path, slash - path); if (! parent) { fprintf (stderr, "Error: %s\n", strerror (ENOMEM)); - return FALSE; + return false; } if (! mkdir_recursive (ctx, parent, mode)) - return FALSE; + return false; } if (mkdir (path, mode)) { fprintf (stderr, "Error: mkdir '%s': %s\n", path, strerror (errno)); - return FALSE; + return false; } - return parent ? sync_dir (parent) : TRUE; + return parent ? sync_dir (parent) : true; } /* * Create the given maildir folder, i.e. maildir and its - * subdirectories cur/new/tmp. Return TRUE on success, FALSE + * 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 (const void *ctx, const char *maildir) +static bool +maildir_create_folder (const void *ctx, const char *maildir, bool world_readable) { const char *subdirs[] = { "cur", "new", "tmp" }; - const int mode = 0700; + const int mode = (world_readable ? 0755 : 0700); char *subdir; unsigned int i; @@ -169,14 +170,14 @@ maildir_create_folder (const void *ctx, const char *maildir) subdir = talloc_asprintf (ctx, "%s/%s", maildir, subdirs[i]); if (! subdir) { fprintf (stderr, "Error: %s\n", strerror (ENOMEM)); - return FALSE; + return false; } if (! mkdir_recursive (ctx, subdir, mode)) - return FALSE; + return false; } - return TRUE; + return true; } /* @@ -197,7 +198,7 @@ tempfilename (const void *ctx) gettimeofday (&tv, NULL); filename = talloc_asprintf (ctx, "%ld.M%ldP%d.%s", - tv.tv_sec, tv.tv_usec, pid, hostname); + (long) tv.tv_sec, (long) tv.tv_usec, pid, hostname); if (! filename) fprintf (stderr, "Error: %s\n", strerror (ENOMEM)); @@ -210,10 +211,11 @@ tempfilename (const void *ctx) * is not touched). */ static int -maildir_mktemp (const void *ctx, const char *maildir, char **path_out) +maildir_mktemp (const void *ctx, const char *maildir, bool world_readable, char **path_out) { char *filename, *path; int fd; + const int mode = (world_readable ? 0644 : 0600); do { filename = tempfilename (ctx); @@ -226,7 +228,7 @@ maildir_mktemp (const void *ctx, const char *maildir, char **path_out) return -1; } - fd = open (path, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0600); + fd = open (path, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode); } while (fd == -1 && errno == EEXIST); if (fd == -1) { @@ -239,19 +241,41 @@ maildir_mktemp (const void *ctx, const char *maildir, char **path_out) return fd; } +static bool +write_buf (const char *buf, int fdout, ssize_t remain) +{ + const char *p = buf; + + do { + ssize_t written = write (fdout, p, remain); + if (written < 0 && errno == EINTR) + continue; + if (written <= 0) { + fprintf (stderr, "Error: writing to temporary file: %s", + strerror (errno)); + return false; + } + p += written; + remain -= written; + } while (remain > 0); + return true; +} + /* - * Copy fdin to fdout, return TRUE on success, and FALSE on errors and + * Copy fdin to fdout, return true on success, and false on errors and * empty input. */ -static notmuch_bool_t +static bool copy_fd (int fdout, int fdin) { - notmuch_bool_t empty = TRUE; + bool empty = true; + bool first = true; + const char *header = "X-Envelope-From: "; while (! interrupted) { ssize_t remain; char buf[4096]; - char *p; + const char *p = buf; remain = read (fdin, buf, sizeof (buf)); if (remain == 0) @@ -261,26 +285,24 @@ copy_fd (int fdout, int fdin) continue; fprintf (stderr, "Error: reading from standard input: %s\n", strerror (errno)); - return FALSE; + return false; } - p = buf; - do { - ssize_t written = write (fdout, p, remain); - if (written < 0 && errno == EINTR) - continue; - if (written <= 0) { - fprintf (stderr, "Error: writing to temporary file: %s", - strerror (errno)); - return FALSE; - } - p += written; - remain -= written; - empty = FALSE; - } while (remain > 0); + if (first && remain >= 5 && 0 == strncmp (buf, "From ", 5)) { + if (! write_buf (header, fdout, strlen (header))) + return false; + p += 5; + remain -= 5; + } + + first = false; + + if (! write_buf (p, fdout, remain)) + return false; + empty = false; } - return (!interrupted && !empty); + return (! interrupted && ! empty); } /* @@ -288,12 +310,12 @@ copy_fd (int fdout, int fdin) * the file, or NULL on errors. */ static char * -maildir_write_tmp (const void *ctx, int fdin, const char *maildir) +maildir_write_tmp (const void *ctx, int fdin, const char *maildir, bool world_readable) { char *path; int fdout; - fdout = maildir_mktemp (ctx, maildir, &path); + fdout = maildir_mktemp (ctx, maildir, world_readable, &path); if (fdout < 0) return NULL; @@ -309,7 +331,7 @@ maildir_write_tmp (const void *ctx, int fdin, const char *maildir) return path; -FAIL: + FAIL: close (fdout); unlink (path); @@ -322,11 +344,11 @@ FAIL: * errors. */ static char * -maildir_write_new (const void *ctx, int fdin, const char *maildir) +maildir_write_new (const void *ctx, int fdin, const char *maildir, bool world_readable) { char *cleanpath, *tmppath, *newpath, *newdir; - tmppath = maildir_write_tmp (ctx, fdin, maildir); + tmppath = maildir_write_tmp (ctx, fdin, maildir, world_readable); if (! tmppath) return NULL; cleanpath = tmppath; @@ -358,110 +380,161 @@ maildir_write_new (const void *ctx, int fdin, const char *maildir) return newpath; -FAIL: + FAIL: unlink (cleanpath); return NULL; } -/* 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) +/* + * 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, + bool synchronize_flags, bool keep, + notmuch_indexopts_t *indexopts) { notmuch_message_t *message; notmuch_status_t status; - 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; - } - - 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"); + status = notmuch_database_index_file (notmuch, path, indexopts, &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 { - tag_op_flag_t flags = synchronize_flags ? TAG_FLAG_MAILDIR_SYNC : 0; + fprintf (stderr, "Error: failed to add '%s' to notmuch database: %s\n", + path, notmuch_status_to_string (status)); + goto FAIL; + } - tag_op_list_apply (message, tag_ops, flags); + 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: + return status; } int -notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]) +notmuch_insert_command (notmuch_database_t *notmuch, int argc, char *argv[]) { - notmuch_database_t *notmuch; + notmuch_status_t status, close_status; struct sigaction action; - const char *db_path; - const char **new_tags; - size_t new_tags_length; + const char *mail_root; + notmuch_config_values_t *new_tags = NULL; tag_op_list_t *tag_ops; char *query_string = NULL; - const char *folder = NULL; - notmuch_bool_t create_folder = FALSE; + const char *folder = ""; + bool create_folder = false; + bool keep = false; + bool hooks = true; + bool world_readable = false; notmuch_bool_t synchronize_flags; - const char *maildir; + char *maildir; char *newpath; int opt_index; - unsigned int i; + notmuch_indexopts_t *indexopts = notmuch_database_get_default_indexopts (notmuch); + + void *local = talloc_new (NULL); notmuch_opt_desc_t options[] = { - { NOTMUCH_OPT_STRING, &folder, "folder", 0, 0 }, - { NOTMUCH_OPT_BOOLEAN, &create_folder, "create-folder", 0, 0 }, - { NOTMUCH_OPT_END, 0, 0, 0, 0 } + { .opt_string = &folder, .name = "folder", .allow_empty = true }, + { .opt_bool = &create_folder, .name = "create-folder" }, + { .opt_bool = &keep, .name = "keep" }, + { .opt_bool = &hooks, .name = "hooks" }, + { .opt_bool = &world_readable, .name = "world-readable" }, + { .opt_inherit = notmuch_shared_indexing_options }, + { .opt_inherit = notmuch_shared_options }, + { } }; opt_index = parse_arguments (argc, argv, options, 1); if (opt_index < 0) return EXIT_FAILURE; - db_path = notmuch_config_get_database_path (config); - new_tags = notmuch_config_get_new_tags (config, &new_tags_length); - synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config); + notmuch_process_shared_options (notmuch, argv[0]); + + mail_root = notmuch_config_get (notmuch, NOTMUCH_CONFIG_MAIL_ROOT); - tag_ops = tag_op_list_create (config); + new_tags = notmuch_config_get_values (notmuch, NOTMUCH_CONFIG_NEW_TAGS); + + if (print_status_database ( + "notmuch insert", + notmuch, + notmuch_config_get_bool (notmuch, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS, + &synchronize_flags))) + return EXIT_FAILURE; + + tag_ops = tag_op_list_create (local); if (tag_ops == NULL) { fprintf (stderr, "Out of memory.\n"); return EXIT_FAILURE; } - for (i = 0; i < new_tags_length; i++) { + for (; + notmuch_config_values_valid (new_tags); + notmuch_config_values_move_to_next (new_tags)) { const char *error_msg; - - error_msg = illegal_tag (new_tags[i], FALSE); + const char *tag = notmuch_config_values_get (new_tags); + error_msg = illegal_tag (tag, false); if (error_msg) { fprintf (stderr, "Error: tag '%s' in new.tags: %s\n", - new_tags[i], error_msg); + tag, error_msg); return EXIT_FAILURE; } - if (tag_op_list_append (tag_ops, new_tags[i], FALSE)) + if (tag_op_list_append (tag_ops, tag, false)) return EXIT_FAILURE; } - if (parse_tag_command_line (config, argc - opt_index, argv + opt_index, + if (parse_tag_command_line (local, argc - opt_index, argv + opt_index, &query_string, tag_ops)) return EXIT_FAILURE; @@ -470,23 +543,22 @@ notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]) return EXIT_FAILURE; } - if (folder == NULL) { - maildir = db_path; - } else { - 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); - if (! maildir) { - fprintf (stderr, "Out of memory\n"); - return EXIT_FAILURE; - } - if (create_folder && ! maildir_create_folder (config, maildir)) - return EXIT_FAILURE; + if (! is_valid_folder_name (folder)) { + fprintf (stderr, "Error: invalid folder name: '%s'\n", folder); + return EXIT_FAILURE; } - /* Setup our handler for SIGINT. We do not set SA_RESTART so that copying + maildir = talloc_asprintf (local, "%s/%s", mail_root, folder); + if (! maildir) { + fprintf (stderr, "Out of memory\n"); + return EXIT_FAILURE; + } + + strip_trailing (maildir, '/'); + if (create_folder && ! maildir_create_folder (local, maildir, world_readable)) + return EXIT_FAILURE; + + /* Set up our handler for SIGINT. We do not set SA_RESTART so that copying * from standard input may be interrupted. */ memset (&action, 0, sizeof (struct sigaction)); action.sa_handler = handle_sigint; @@ -494,23 +566,54 @@ notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]) action.sa_flags = 0; sigaction (SIGINT, &action, NULL); - if (notmuch_database_open (notmuch_config_get_database_path (config), - NOTMUCH_DATABASE_MODE_READ_WRITE, ¬much)) - return EXIT_FAILURE; - /* Write the message to the Maildir new directory. */ - newpath = maildir_write_new (config, STDIN_FILENO, maildir); + newpath = maildir_write_new (local, STDIN_FILENO, maildir, world_readable); if (! newpath) { - notmuch_database_destroy (notmuch); return EXIT_FAILURE; } - /* Add the message to the index. - * 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); + status = notmuch_process_shared_indexing_options (indexopts); + if (status != NOTMUCH_STATUS_SUCCESS) { + fprintf (stderr, "Error: Failed to process index options. (%s)\n", + notmuch_status_to_string (status)); + return EXIT_FAILURE; + } + + /* Index the message. */ + status = add_file (notmuch, newpath, tag_ops, synchronize_flags, keep, indexopts); + + /* Commit changes. */ + close_status = notmuch_database_close (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)); + } + + 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)); + } + } + } + + if (hooks && status == NOTMUCH_STATUS_SUCCESS) { + /* Ignore hook failures. */ + notmuch_run_hook (notmuch, "post-insert"); + } notmuch_database_destroy (notmuch); - return EXIT_SUCCESS; + + talloc_free (local); + + return status_to_exit (status); }