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.
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.
162 maildir_create_folder (const void *ctx, const char *maildir, bool world_readable)
164 const char *subdirs[] = { "cur", "new", "tmp" };
165 const int mode = (world_readable ? 0755 : 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, bool world_readable, char **path_out)
216 char *filename, *path;
218 const int mode = (world_readable ? 0644 : 0600);
221 filename = tempfilename (ctx);
225 path = talloc_asprintf (ctx, "%s/tmp/%s", maildir, filename);
227 fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
231 fd = open (path, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode);
232 } while (fd == -1 && errno == EEXIST);
235 fprintf (stderr, "Error: open '%s': %s\n", path, strerror (errno));
245 * Copy fdin to fdout, return true on success, and false on errors and
249 copy_fd (int fdout, int fdin)
253 while (! interrupted) {
258 remain = read (fdin, buf, sizeof (buf));
264 fprintf (stderr, "Error: reading from standard input: %s\n",
271 ssize_t written = write (fdout, p, remain);
272 if (written < 0 && errno == EINTR)
275 fprintf (stderr, "Error: writing to temporary file: %s",
282 } while (remain > 0);
285 return (!interrupted && !empty);
289 * Write fdin to a new temp file in maildir/tmp, return full path to
290 * the file, or NULL on errors.
293 maildir_write_tmp (const void *ctx, int fdin, const char *maildir, bool world_readable)
298 fdout = maildir_mktemp (ctx, maildir, world_readable, &path);
302 if (! copy_fd (fdout, fdin))
306 fprintf (stderr, "Error: fsync '%s': %s\n", path, strerror (errno));
322 * Write fdin to a new file in maildir/new, using an intermediate temp
323 * file in maildir/tmp, return full path to the new file, or NULL on
327 maildir_write_new (const void *ctx, int fdin, const char *maildir, bool world_readable)
329 char *cleanpath, *tmppath, *newpath, *newdir;
331 tmppath = maildir_write_tmp (ctx, fdin, maildir, world_readable);
336 newpath = talloc_strdup (ctx, tmppath);
338 fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
342 /* sanity checks needed? */
343 memcpy (newpath + strlen (maildir) + 1, "new", 3);
345 if (rename (tmppath, newpath)) {
346 fprintf (stderr, "Error: rename '%s' '%s': %s\n",
347 tmppath, newpath, strerror (errno));
352 newdir = talloc_asprintf (ctx, "%s/%s", maildir, "new");
354 fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
358 if (! sync_dir (newdir))
370 * Add the specified message file to the notmuch database, applying
371 * tags in tag_ops. If synchronize_flags is true, the tags are
372 * synchronized to maildir flags (which may result in message file
375 * Return NOTMUCH_STATUS_SUCCESS on success, errors otherwise. If keep
376 * is true, errors in tag changes and flag syncing are ignored and
377 * success status is returned; otherwise such errors cause the message
378 * to be removed from the database. Failure to add the message to the
379 * database results in error status regardless of keep.
381 static notmuch_status_t
382 add_file (notmuch_database_t *notmuch, const char *path, tag_op_list_t *tag_ops,
383 bool synchronize_flags, bool keep,
384 notmuch_indexopts_t *indexopts)
386 notmuch_message_t *message;
387 notmuch_status_t status;
389 status = notmuch_database_index_file (notmuch, path, indexopts, &message);
390 if (status == NOTMUCH_STATUS_SUCCESS) {
391 status = tag_op_list_apply (message, tag_ops, 0);
393 fprintf (stderr, "%s: failed to apply tags to file '%s': %s\n",
394 keep ? "Warning" : "Error",
395 path, notmuch_status_to_string (status));
398 } else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
399 status = NOTMUCH_STATUS_SUCCESS;
400 } else if (status == NOTMUCH_STATUS_FILE_NOT_EMAIL) {
401 fprintf (stderr, "Error: delivery of non-mail file: '%s'\n", path);
404 fprintf (stderr, "Error: failed to add '%s' to notmuch database: %s\n",
405 path, notmuch_status_to_string (status));
409 if (synchronize_flags) {
410 status = notmuch_message_tags_to_maildir_flags (message);
411 if (status != NOTMUCH_STATUS_SUCCESS)
412 fprintf (stderr, "%s: failed to sync tags to maildir flags for '%s': %s\n",
413 keep ? "Warning" : "Error",
414 path, notmuch_status_to_string (status));
417 * Note: Unfortunately a failed maildir flag sync might
418 * already have renamed the file, in which case the cleanup
424 notmuch_message_destroy (message);
428 status = NOTMUCH_STATUS_SUCCESS;
430 notmuch_status_t cleanup_status;
432 cleanup_status = notmuch_database_remove_message (notmuch, path);
433 if (cleanup_status != NOTMUCH_STATUS_SUCCESS &&
434 cleanup_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
435 fprintf (stderr, "Warning: failed to remove '%s' from database "
436 "after errors: %s. Please run 'notmuch new' to fix.\n",
437 path, notmuch_status_to_string (cleanup_status));
447 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])
449 notmuch_status_t status, close_status;
450 notmuch_database_t *notmuch;
451 struct sigaction action;
453 const char **new_tags;
454 size_t new_tags_length;
455 tag_op_list_t *tag_ops;
456 char *query_string = NULL;
457 const char *folder = "";
458 bool create_folder = false;
461 bool world_readable = false;
462 bool synchronize_flags;
468 notmuch_opt_desc_t options[] = {
469 { .opt_string = &folder, .name = "folder", .allow_empty = true },
470 { .opt_bool = &create_folder, .name = "create-folder" },
471 { .opt_bool = &keep, .name = "keep" },
472 { .opt_bool = &hooks, .name = "hooks" },
473 { .opt_bool = &world_readable, .name = "world-readable" },
474 { .opt_inherit = notmuch_shared_indexing_options },
475 { .opt_inherit = notmuch_shared_options },
479 opt_index = parse_arguments (argc, argv, options, 1);
483 notmuch_process_shared_options (argv[0]);
485 db_path = notmuch_config_get_database_path (config);
486 new_tags = notmuch_config_get_new_tags (config, &new_tags_length);
487 synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);
489 tag_ops = tag_op_list_create (config);
490 if (tag_ops == NULL) {
491 fprintf (stderr, "Out of memory.\n");
494 for (i = 0; i < new_tags_length; i++) {
495 const char *error_msg;
497 error_msg = illegal_tag (new_tags[i], false);
499 fprintf (stderr, "Error: tag '%s' in new.tags: %s\n",
500 new_tags[i], error_msg);
504 if (tag_op_list_append (tag_ops, new_tags[i], false))
508 if (parse_tag_command_line (config, argc - opt_index, argv + opt_index,
509 &query_string, tag_ops))
512 if (*query_string != '\0') {
513 fprintf (stderr, "Error: unexpected query string: %s\n", query_string);
517 if (! is_valid_folder_name (folder)) {
518 fprintf (stderr, "Error: invalid folder name: '%s'\n", folder);
522 maildir = talloc_asprintf (config, "%s/%s", db_path, folder);
524 fprintf (stderr, "Out of memory\n");
528 strip_trailing (maildir, '/');
529 if (create_folder && ! maildir_create_folder (config, maildir, world_readable))
532 /* Set up our handler for SIGINT. We do not set SA_RESTART so that copying
533 * from standard input may be interrupted. */
534 memset (&action, 0, sizeof (struct sigaction));
535 action.sa_handler = handle_sigint;
536 sigemptyset (&action.sa_mask);
538 sigaction (SIGINT, &action, NULL);
540 /* Write the message to the Maildir new directory. */
541 newpath = maildir_write_new (config, STDIN_FILENO, maildir, world_readable);
546 status = notmuch_database_open (notmuch_config_get_database_path (config),
547 NOTMUCH_DATABASE_MODE_READ_WRITE, ¬much);
549 return keep ? NOTMUCH_STATUS_SUCCESS : status_to_exit (status);
551 notmuch_exit_if_unmatched_db_uuid (notmuch);
553 status = notmuch_process_shared_indexing_options (notmuch);
554 if (status != NOTMUCH_STATUS_SUCCESS) {
555 fprintf (stderr, "Error: Failed to process index options. (%s)\n",
556 notmuch_status_to_string (status));
560 /* Index the message. */
561 status = add_file (notmuch, newpath, tag_ops, synchronize_flags, keep, indexing_cli_choices.opts);
563 /* Commit changes. */
564 close_status = notmuch_database_destroy (notmuch);
566 /* Hold on to the first error, if any. */
568 status = close_status;
569 fprintf (stderr, "%s: failed to commit database changes: %s\n",
570 keep ? "Warning" : "Error",
571 notmuch_status_to_string (close_status));
576 status = NOTMUCH_STATUS_SUCCESS;
578 /* If maildir flag sync failed, this might fail. */
579 if (unlink (newpath)) {
580 fprintf (stderr, "Warning: failed to remove '%s' from maildir "
581 "after errors: %s. Please run 'notmuch new' to fix.\n",
582 newpath, strerror (errno));
587 if (hooks && status == NOTMUCH_STATUS_SUCCESS) {
588 /* Ignore hook failures. */
589 notmuch_run_hook (db_path, "post-insert");
592 return status_to_exit (status);