1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2013 Peter Wang
5 * Based in part on notmuch-deliver
6 * Copyright © 2010 Ali Polatel
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see https://www.gnu.org/licenses/ .
21 * Author: Peter Wang <novalazy@gmail.com>
24 #include "notmuch-client.h"
27 #include <sys/types.h>
30 #include "string-util.h"
32 static volatile sig_atomic_t interrupted;
35 handle_sigint (unused (int sig))
37 static char msg[] = "Stopping... \n";
39 /* This write is "opportunistic", so it's okay to ignore the
40 * result. It is not required for correctness, and if it does
41 * fail or produce a short write, we want to get out of the signal
42 * handler as quickly as possible, not retry it. */
43 IGNORE_RESULT (write (2, msg, sizeof (msg) - 1));
47 /* Like gethostname but guarantees that a null-terminated hostname is
48 * returned, even if it has to make one up. Invalid characters are
49 * substituted such that the hostname can be used within a filename.
52 safe_gethostname (char *hostname, size_t len)
56 if (gethostname (hostname, len) == -1) {
57 strncpy (hostname, "unknown", len);
59 hostname[len - 1] = '\0';
61 for (p = hostname; *p != '\0'; p++) {
62 if (*p == '/' || *p == ':')
67 /* Call fsync() on a directory path. */
69 sync_dir (const char *dir)
73 fd = open (dir, O_RDONLY);
75 fprintf (stderr, "Error: open %s: %s\n", dir, strerror (errno));
81 fprintf (stderr, "Error: fsync %s: %s\n", dir, strerror (errno));
89 * Check the specified folder name does not contain a directory
90 * component ".." to prevent writes outside of the Maildir
91 * hierarchy. Return TRUE on valid folder name, FALSE otherwise.
94 is_valid_folder_name (const char *folder)
96 const char *p = folder;
99 if ((p[0] == '.') && (p[1] == '.') && (p[2] == '\0' || p[2] == '/'))
109 * Make the given directory and its parents as necessary, using the
110 * given mode. Return TRUE on success, FALSE otherwise. Partial
111 * results are not cleaned up on errors.
113 static notmuch_bool_t
114 mkdir_recursive (const void *ctx, const char *path, int mode)
118 char *parent = NULL, *slash;
120 /* First check the common case: directory already exists. */
121 r = stat (path, &st);
123 if (! S_ISDIR (st.st_mode)) {
124 fprintf (stderr, "Error: '%s' is not a directory: %s\n",
125 path, strerror (EEXIST));
130 } else if (errno != ENOENT) {
131 fprintf (stderr, "Error: stat '%s': %s\n", path, strerror (errno));
135 /* mkdir parents, if any */
136 slash = strrchr (path, '/');
137 if (slash && slash != path) {
138 parent = talloc_strndup (ctx, path, slash - path);
140 fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
144 if (! mkdir_recursive (ctx, parent, mode))
148 if (mkdir (path, mode)) {
149 fprintf (stderr, "Error: mkdir '%s': %s\n", path, strerror (errno));
153 return parent ? sync_dir (parent) : TRUE;
157 * Create the given maildir folder, i.e. maildir and its
158 * subdirectories cur/new/tmp. Return TRUE on success, FALSE
159 * otherwise. Partial results are not cleaned up on errors.
161 static notmuch_bool_t
162 maildir_create_folder (const void *ctx, const char *maildir)
164 const char *subdirs[] = { "cur", "new", "tmp" };
165 const int mode = 0700;
169 for (i = 0; i < ARRAY_SIZE (subdirs); i++) {
170 subdir = talloc_asprintf (ctx, "%s/%s", maildir, subdirs[i]);
172 fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
176 if (! mkdir_recursive (ctx, subdir, mode))
184 * Generate a temporary file basename, no path, do not create an
185 * actual file. Return the basename, or NULL on errors.
188 tempfilename (const void *ctx)
195 /* We follow the Dovecot file name generation algorithm. */
197 safe_gethostname (hostname, sizeof (hostname));
198 gettimeofday (&tv, NULL);
200 filename = talloc_asprintf (ctx, "%ld.M%ldP%d.%s",
201 (long) tv.tv_sec, (long) tv.tv_usec, pid, hostname);
203 fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
209 * Create a unique temporary file in maildir/tmp, return fd and full
210 * path to file in *path_out, or -1 on errors (in which case *path_out
214 maildir_mktemp (const void *ctx, const char *maildir, char **path_out)
216 char *filename, *path;
220 filename = tempfilename (ctx);
224 path = talloc_asprintf (ctx, "%s/tmp/%s", maildir, filename);
226 fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
230 fd = open (path, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0600);
231 } while (fd == -1 && errno == EEXIST);
234 fprintf (stderr, "Error: open '%s': %s\n", path, strerror (errno));
244 * Copy fdin to fdout, return TRUE on success, and FALSE on errors and
247 static notmuch_bool_t
248 copy_fd (int fdout, int fdin)
250 notmuch_bool_t empty = TRUE;
252 while (! interrupted) {
257 remain = read (fdin, buf, sizeof (buf));
263 fprintf (stderr, "Error: reading from standard input: %s\n",
270 ssize_t written = write (fdout, p, remain);
271 if (written < 0 && errno == EINTR)
274 fprintf (stderr, "Error: writing to temporary file: %s",
281 } while (remain > 0);
284 return (!interrupted && !empty);
288 * Write fdin to a new temp file in maildir/tmp, return full path to
289 * the file, or NULL on errors.
292 maildir_write_tmp (const void *ctx, int fdin, const char *maildir)
297 fdout = maildir_mktemp (ctx, maildir, &path);
301 if (! copy_fd (fdout, fdin))
305 fprintf (stderr, "Error: fsync '%s': %s\n", path, strerror (errno));
321 * Write fdin to a new file in maildir/new, using an intermediate temp
322 * file in maildir/tmp, return full path to the new file, or NULL on
326 maildir_write_new (const void *ctx, int fdin, const char *maildir)
328 char *cleanpath, *tmppath, *newpath, *newdir;
330 tmppath = maildir_write_tmp (ctx, fdin, maildir);
335 newpath = talloc_strdup (ctx, tmppath);
337 fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
341 /* sanity checks needed? */
342 memcpy (newpath + strlen (maildir) + 1, "new", 3);
344 if (rename (tmppath, newpath)) {
345 fprintf (stderr, "Error: rename '%s' '%s': %s\n",
346 tmppath, newpath, strerror (errno));
351 newdir = talloc_asprintf (ctx, "%s/%s", maildir, "new");
353 fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
357 if (! sync_dir (newdir))
369 * Add the specified message file to the notmuch database, applying
370 * tags in tag_ops. If synchronize_flags is TRUE, the tags are
371 * synchronized to maildir flags (which may result in message file
374 * Return NOTMUCH_STATUS_SUCCESS on success, errors otherwise. If keep
375 * is TRUE, errors in tag changes and flag syncing are ignored and
376 * success status is returned; otherwise such errors cause the message
377 * to be removed from the database. Failure to add the message to the
378 * database results in error status regardless of keep.
380 static notmuch_status_t
381 add_file (notmuch_database_t *notmuch, const char *path, tag_op_list_t *tag_ops,
382 notmuch_bool_t synchronize_flags, notmuch_bool_t keep)
384 notmuch_message_t *message;
385 notmuch_status_t status;
387 status = notmuch_database_index_file (notmuch, path, NULL, &message);
388 if (status == NOTMUCH_STATUS_SUCCESS) {
389 status = tag_op_list_apply (message, tag_ops, 0);
391 fprintf (stderr, "%s: failed to apply tags to file '%s': %s\n",
392 keep ? "Warning" : "Error",
393 path, notmuch_status_to_string (status));
396 } else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
397 status = NOTMUCH_STATUS_SUCCESS;
398 } else if (status == NOTMUCH_STATUS_FILE_NOT_EMAIL) {
399 fprintf (stderr, "Error: delivery of non-mail file: '%s'\n", path);
402 fprintf (stderr, "Error: failed to add '%s' to notmuch database: %s\n",
403 path, notmuch_status_to_string (status));
407 if (synchronize_flags) {
408 status = notmuch_message_tags_to_maildir_flags (message);
409 if (status != NOTMUCH_STATUS_SUCCESS)
410 fprintf (stderr, "%s: failed to sync tags to maildir flags for '%s': %s\n",
411 keep ? "Warning" : "Error",
412 path, notmuch_status_to_string (status));
415 * Note: Unfortunately a failed maildir flag sync might
416 * already have renamed the file, in which case the cleanup
422 notmuch_message_destroy (message);
426 status = NOTMUCH_STATUS_SUCCESS;
428 notmuch_status_t cleanup_status;
430 cleanup_status = notmuch_database_remove_message (notmuch, path);
431 if (cleanup_status != NOTMUCH_STATUS_SUCCESS &&
432 cleanup_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
433 fprintf (stderr, "Warning: failed to remove '%s' from database "
434 "after errors: %s. Please run 'notmuch new' to fix.\n",
435 path, notmuch_status_to_string (cleanup_status));
445 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])
447 notmuch_status_t status, close_status;
448 notmuch_database_t *notmuch;
449 struct sigaction action;
451 const char **new_tags;
452 size_t new_tags_length;
453 tag_op_list_t *tag_ops;
454 char *query_string = NULL;
455 const char *folder = "";
456 notmuch_bool_t create_folder = FALSE;
457 notmuch_bool_t keep = FALSE;
458 notmuch_bool_t no_hooks = FALSE;
459 notmuch_bool_t synchronize_flags;
465 notmuch_opt_desc_t options[] = {
466 { .opt_string = &folder, .name = "folder" },
467 { .opt_bool = &create_folder, .name = "create-folder" },
468 { .opt_bool = &keep, .name = "keep" },
469 { .opt_bool = &no_hooks, .name = "no-hooks" },
470 { .opt_inherit = notmuch_shared_options },
474 opt_index = parse_arguments (argc, argv, options, 1);
478 notmuch_process_shared_options (argv[0]);
480 db_path = notmuch_config_get_database_path (config);
481 new_tags = notmuch_config_get_new_tags (config, &new_tags_length);
482 synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);
484 tag_ops = tag_op_list_create (config);
485 if (tag_ops == NULL) {
486 fprintf (stderr, "Out of memory.\n");
489 for (i = 0; i < new_tags_length; i++) {
490 const char *error_msg;
492 error_msg = illegal_tag (new_tags[i], FALSE);
494 fprintf (stderr, "Error: tag '%s' in new.tags: %s\n",
495 new_tags[i], error_msg);
499 if (tag_op_list_append (tag_ops, new_tags[i], FALSE))
503 if (parse_tag_command_line (config, argc - opt_index, argv + opt_index,
504 &query_string, tag_ops))
507 if (*query_string != '\0') {
508 fprintf (stderr, "Error: unexpected query string: %s\n", query_string);
512 if (! is_valid_folder_name (folder)) {
513 fprintf (stderr, "Error: invalid folder name: '%s'\n", folder);
517 maildir = talloc_asprintf (config, "%s/%s", db_path, folder);
519 fprintf (stderr, "Out of memory\n");
523 strip_trailing (maildir, '/');
524 if (create_folder && ! maildir_create_folder (config, maildir))
527 /* Set up our handler for SIGINT. We do not set SA_RESTART so that copying
528 * from standard input may be interrupted. */
529 memset (&action, 0, sizeof (struct sigaction));
530 action.sa_handler = handle_sigint;
531 sigemptyset (&action.sa_mask);
533 sigaction (SIGINT, &action, NULL);
535 /* Write the message to the Maildir new directory. */
536 newpath = maildir_write_new (config, STDIN_FILENO, maildir);
541 status = notmuch_database_open (notmuch_config_get_database_path (config),
542 NOTMUCH_DATABASE_MODE_READ_WRITE, ¬much);
544 return keep ? NOTMUCH_STATUS_SUCCESS : status_to_exit (status);
546 notmuch_exit_if_unmatched_db_uuid (notmuch);
549 /* Index the message. */
550 status = add_file (notmuch, newpath, tag_ops, synchronize_flags, keep);
552 /* Commit changes. */
553 close_status = notmuch_database_destroy (notmuch);
555 /* Hold on to the first error, if any. */
557 status = close_status;
558 fprintf (stderr, "%s: failed to commit database changes: %s\n",
559 keep ? "Warning" : "Error",
560 notmuch_status_to_string (close_status));
565 status = NOTMUCH_STATUS_SUCCESS;
567 /* If maildir flag sync failed, this might fail. */
568 if (unlink (newpath)) {
569 fprintf (stderr, "Warning: failed to remove '%s' from maildir "
570 "after errors: %s. Please run 'notmuch new' to fix.\n",
571 newpath, strerror (errno));
576 if (! no_hooks && status == NOTMUCH_STATUS_SUCCESS) {
577 /* Ignore hook failures. */
578 notmuch_run_hook (db_path, "post-insert");
581 return status_to_exit (status);