cli/insert: delay database open until after writing mail file
[notmuch] / notmuch-insert.c
1 /* notmuch - Not much of an email program, (just index and search)
2  *
3  * Copyright © 2013 Peter Wang
4  *
5  * Based in part on notmuch-deliver
6  * Copyright © 2010 Ali Polatel
7  *
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.
12  *
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.
17  *
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/ .
20  *
21  * Author: Peter Wang <novalazy@gmail.com>
22  */
23
24 #include "notmuch-client.h"
25 #include "tag-util.h"
26
27 #include <sys/types.h>
28 #include <sys/stat.h>
29 #include <fcntl.h>
30
31 static volatile sig_atomic_t interrupted;
32
33 static void
34 handle_sigint (unused (int sig))
35 {
36     static char msg[] = "Stopping...         \n";
37
38     /* This write is "opportunistic", so it's okay to ignore the
39      * result.  It is not required for correctness, and if it does
40      * fail or produce a short write, we want to get out of the signal
41      * handler as quickly as possible, not retry it. */
42     IGNORE_RESULT (write (2, msg, sizeof (msg) - 1));
43     interrupted = 1;
44 }
45
46 /* Like gethostname but guarantees that a null-terminated hostname is
47  * returned, even if it has to make one up. Invalid characters are
48  * substituted such that the hostname can be used within a filename.
49  */
50 static void
51 safe_gethostname (char *hostname, size_t len)
52 {
53     char *p;
54
55     if (gethostname (hostname, len) == -1) {
56         strncpy (hostname, "unknown", len);
57     }
58     hostname[len - 1] = '\0';
59
60     for (p = hostname; *p != '\0'; p++) {
61         if (*p == '/' || *p == ':')
62             *p = '_';
63     }
64 }
65
66 /* Call fsync() on a directory path. */
67 static notmuch_bool_t
68 sync_dir (const char *dir)
69 {
70     int fd, r;
71
72     fd = open (dir, O_RDONLY);
73     if (fd == -1) {
74         fprintf (stderr, "Error: open %s: %s\n", dir, strerror (errno));
75         return FALSE;
76     }
77
78     r = fsync (fd);
79     if (r)
80         fprintf (stderr, "Error: fsync %s: %s\n", dir, strerror (errno));
81
82     close (fd);
83
84     return r == 0;
85 }
86
87 /*
88  * Check the specified folder name does not contain a directory
89  * component ".." to prevent writes outside of the Maildir
90  * hierarchy. Return TRUE on valid folder name, FALSE otherwise.
91  */
92 static notmuch_bool_t
93 is_valid_folder_name (const char *folder)
94 {
95     const char *p = folder;
96
97     for (;;) {
98         if ((p[0] == '.') && (p[1] == '.') && (p[2] == '\0' || p[2] == '/'))
99             return FALSE;
100         p = strchr (p, '/');
101         if (!p)
102             return TRUE;
103         p++;
104     }
105 }
106
107 /*
108  * Make the given directory and its parents as necessary, using the
109  * given mode. Return TRUE on success, FALSE otherwise. Partial
110  * results are not cleaned up on errors.
111  */
112 static notmuch_bool_t
113 mkdir_recursive (const void *ctx, const char *path, int mode)
114 {
115     struct stat st;
116     int r;
117     char *parent = NULL, *slash;
118
119     /* First check the common case: directory already exists. */
120     r = stat (path, &st);
121     if (r == 0) {
122         if (! S_ISDIR (st.st_mode)) {
123             fprintf (stderr, "Error: '%s' is not a directory: %s\n",
124                      path, strerror (EEXIST));
125             return FALSE;
126         }
127
128         return TRUE;
129     } else if (errno != ENOENT) {
130         fprintf (stderr, "Error: stat '%s': %s\n", path, strerror (errno));
131         return FALSE;
132     }
133
134     /* mkdir parents, if any */
135     slash = strrchr (path, '/');
136     if (slash && slash != path) {
137         parent = talloc_strndup (ctx, path, slash - path);
138         if (! parent) {
139             fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
140             return FALSE;
141         }
142
143         if (! mkdir_recursive (ctx, parent, mode))
144             return FALSE;
145     }
146
147     if (mkdir (path, mode)) {
148         fprintf (stderr, "Error: mkdir '%s': %s\n", path, strerror (errno));
149         return FALSE;
150     }
151
152     return parent ? sync_dir (parent) : TRUE;
153 }
154
155 /*
156  * Create the given maildir folder, i.e. maildir and its
157  * subdirectories cur/new/tmp. Return TRUE on success, FALSE
158  * otherwise. Partial results are not cleaned up on errors.
159  */
160 static notmuch_bool_t
161 maildir_create_folder (const void *ctx, const char *maildir)
162 {
163     const char *subdirs[] = { "cur", "new", "tmp" };
164     const int mode = 0700;
165     char *subdir;
166     unsigned int i;
167
168     for (i = 0; i < ARRAY_SIZE (subdirs); i++) {
169         subdir = talloc_asprintf (ctx, "%s/%s", maildir, subdirs[i]);
170         if (! subdir) {
171             fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
172             return FALSE;
173         }
174
175         if (! mkdir_recursive (ctx, subdir, mode))
176             return FALSE;
177     }
178
179     return TRUE;
180 }
181
182 /*
183  * Generate a temporary file basename, no path, do not create an
184  * actual file. Return the basename, or NULL on errors.
185  */
186 static char *
187 tempfilename (const void *ctx)
188 {
189     char *filename;
190     char hostname[256];
191     struct timeval tv;
192     pid_t pid;
193
194     /* We follow the Dovecot file name generation algorithm. */
195     pid = getpid ();
196     safe_gethostname (hostname, sizeof (hostname));
197     gettimeofday (&tv, NULL);
198
199     filename = talloc_asprintf (ctx, "%ld.M%ldP%d.%s",
200                                 (long) tv.tv_sec, (long) tv.tv_usec, pid, hostname);
201     if (! filename)
202         fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
203
204     return filename;
205 }
206
207 /*
208  * Create a unique temporary file in maildir/tmp, return fd and full
209  * path to file in *path_out, or -1 on errors (in which case *path_out
210  * is not touched).
211  */
212 static int
213 maildir_mktemp (const void *ctx, const char *maildir, char **path_out)
214 {
215     char *filename, *path;
216     int fd;
217
218     do {
219         filename = tempfilename (ctx);
220         if (! filename)
221             return -1;
222
223         path = talloc_asprintf (ctx, "%s/tmp/%s", maildir, filename);
224         if (! path) {
225             fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
226             return -1;
227         }
228
229         fd = open (path, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0600);
230     } while (fd == -1 && errno == EEXIST);
231
232     if (fd == -1) {
233         fprintf (stderr, "Error: open '%s': %s\n", path, strerror (errno));
234         return -1;
235     }
236
237     *path_out = path;
238
239     return fd;
240 }
241
242 /*
243  * Copy fdin to fdout, return TRUE on success, and FALSE on errors and
244  * empty input.
245  */
246 static notmuch_bool_t
247 copy_fd (int fdout, int fdin)
248 {
249     notmuch_bool_t empty = TRUE;
250
251     while (! interrupted) {
252         ssize_t remain;
253         char buf[4096];
254         char *p;
255
256         remain = read (fdin, buf, sizeof (buf));
257         if (remain == 0)
258             break;
259         if (remain < 0) {
260             if (errno == EINTR)
261                 continue;
262             fprintf (stderr, "Error: reading from standard input: %s\n",
263                      strerror (errno));
264             return FALSE;
265         }
266
267         p = buf;
268         do {
269             ssize_t written = write (fdout, p, remain);
270             if (written < 0 && errno == EINTR)
271                 continue;
272             if (written <= 0) {
273                 fprintf (stderr, "Error: writing to temporary file: %s",
274                          strerror (errno));
275                 return FALSE;
276             }
277             p += written;
278             remain -= written;
279             empty = FALSE;
280         } while (remain > 0);
281     }
282
283     return (!interrupted && !empty);
284 }
285
286 /*
287  * Write fdin to a new temp file in maildir/tmp, return full path to
288  * the file, or NULL on errors.
289  */
290 static char *
291 maildir_write_tmp (const void *ctx, int fdin, const char *maildir)
292 {
293     char *path;
294     int fdout;
295
296     fdout = maildir_mktemp (ctx, maildir, &path);
297     if (fdout < 0)
298         return NULL;
299
300     if (! copy_fd (fdout, fdin))
301         goto FAIL;
302
303     if (fsync (fdout)) {
304         fprintf (stderr, "Error: fsync '%s': %s\n", path, strerror (errno));
305         goto FAIL;
306     }
307
308     close (fdout);
309
310     return path;
311
312 FAIL:
313     close (fdout);
314     unlink (path);
315
316     return NULL;
317 }
318
319 /*
320  * Write fdin to a new file in maildir/new, using an intermediate temp
321  * file in maildir/tmp, return full path to the new file, or NULL on
322  * errors.
323  */
324 static char *
325 maildir_write_new (const void *ctx, int fdin, const char *maildir)
326 {
327     char *cleanpath, *tmppath, *newpath, *newdir;
328
329     tmppath = maildir_write_tmp (ctx, fdin, maildir);
330     if (! tmppath)
331         return NULL;
332     cleanpath = tmppath;
333
334     newpath = talloc_strdup (ctx, tmppath);
335     if (! newpath) {
336         fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
337         goto FAIL;
338     }
339
340     /* sanity checks needed? */
341     memcpy (newpath + strlen (maildir) + 1, "new", 3);
342
343     if (rename (tmppath, newpath)) {
344         fprintf (stderr, "Error: rename '%s' '%s': %s\n",
345                  tmppath, newpath, strerror (errno));
346         goto FAIL;
347     }
348     cleanpath = newpath;
349
350     newdir = talloc_asprintf (ctx, "%s/%s", maildir, "new");
351     if (! newdir) {
352         fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
353         goto FAIL;
354     }
355
356     if (! sync_dir (newdir))
357         goto FAIL;
358
359     return newpath;
360
361 FAIL:
362     unlink (cleanpath);
363
364     return NULL;
365 }
366
367 /*
368  * Add the specified message file to the notmuch database, applying
369  * tags in tag_ops. If synchronize_flags is TRUE, the tags are
370  * synchronized to maildir flags (which may result in message file
371  * rename).
372  *
373  * Return NOTMUCH_STATUS_SUCCESS on success, errors otherwise. If keep
374  * is TRUE, errors in tag changes and flag syncing are ignored and
375  * success status is returned; otherwise such errors cause the message
376  * to be removed from the database. Failure to add the message to the
377  * database results in error status regardless of keep.
378  */
379 static notmuch_status_t
380 add_file (notmuch_database_t *notmuch, const char *path, tag_op_list_t *tag_ops,
381           notmuch_bool_t synchronize_flags, notmuch_bool_t keep)
382 {
383     notmuch_message_t *message;
384     notmuch_status_t status;
385
386     status = notmuch_database_add_message (notmuch, path, &message);
387     if (status == NOTMUCH_STATUS_SUCCESS) {
388         status = tag_op_list_apply (message, tag_ops, 0);
389         if (status) {
390             fprintf (stderr, "%s: failed to apply tags to file '%s': %s\n",
391                      keep ? "Warning" : "Error",
392                      path, notmuch_status_to_string (status));
393             goto DONE;
394         }
395     } else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
396         status = NOTMUCH_STATUS_SUCCESS;
397     } else if (status == NOTMUCH_STATUS_FILE_NOT_EMAIL) {
398         fprintf (stderr, "Error: delivery of non-mail file: '%s'\n", path);
399         goto FAIL;
400     } else {
401         fprintf (stderr, "Error: failed to add '%s' to notmuch database: %s\n",
402                  path, notmuch_status_to_string (status));
403         goto FAIL;
404     }
405
406     if (synchronize_flags) {
407         status = notmuch_message_tags_to_maildir_flags (message);
408         if (status != NOTMUCH_STATUS_SUCCESS)
409             fprintf (stderr, "%s: failed to sync tags to maildir flags for '%s': %s\n",
410                      keep ? "Warning" : "Error",
411                      path, notmuch_status_to_string (status));
412
413         /*
414          * Note: Unfortunately a failed maildir flag sync might
415          * already have renamed the file, in which case the cleanup
416          * path may fail.
417          */
418     }
419
420   DONE:
421     notmuch_message_destroy (message);
422
423     if (status) {
424         if (keep) {
425             status = NOTMUCH_STATUS_SUCCESS;
426         } else {
427             notmuch_status_t cleanup_status;
428
429             cleanup_status = notmuch_database_remove_message (notmuch, path);
430             if (cleanup_status != NOTMUCH_STATUS_SUCCESS &&
431                 cleanup_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
432                 fprintf (stderr, "Warning: failed to remove '%s' from database "
433                          "after errors: %s. Please run 'notmuch new' to fix.\n",
434                          path, notmuch_status_to_string (cleanup_status));
435             }
436         }
437     }
438
439   FAIL:
440     return status;
441 }
442
443 int
444 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])
445 {
446     notmuch_status_t status, close_status;
447     notmuch_database_t *notmuch;
448     struct sigaction action;
449     const char *db_path;
450     const char **new_tags;
451     size_t new_tags_length;
452     tag_op_list_t *tag_ops;
453     char *query_string = NULL;
454     const char *folder = NULL;
455     notmuch_bool_t create_folder = FALSE;
456     notmuch_bool_t keep = FALSE;
457     notmuch_bool_t no_hooks = FALSE;
458     notmuch_bool_t synchronize_flags;
459     const char *maildir;
460     char *newpath;
461     int opt_index;
462     unsigned int i;
463
464     notmuch_opt_desc_t options[] = {
465         { NOTMUCH_OPT_STRING, &folder, "folder", 0, 0 },
466         { NOTMUCH_OPT_BOOLEAN, &create_folder, "create-folder", 0, 0 },
467         { NOTMUCH_OPT_BOOLEAN, &keep, "keep", 0, 0 },
468         { NOTMUCH_OPT_BOOLEAN,  &no_hooks, "no-hooks", 'n', 0 },
469         { NOTMUCH_OPT_INHERIT, (void *) &notmuch_shared_options, NULL, 0, 0 },
470         { NOTMUCH_OPT_END, 0, 0, 0, 0 }
471     };
472
473     opt_index = parse_arguments (argc, argv, options, 1);
474     if (opt_index < 0)
475         return EXIT_FAILURE;
476
477     notmuch_process_shared_options (argv[0]);
478
479     db_path = notmuch_config_get_database_path (config);
480     new_tags = notmuch_config_get_new_tags (config, &new_tags_length);
481     synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);
482
483     tag_ops = tag_op_list_create (config);
484     if (tag_ops == NULL) {
485         fprintf (stderr, "Out of memory.\n");
486         return EXIT_FAILURE;
487     }
488     for (i = 0; i < new_tags_length; i++) {
489         const char *error_msg;
490
491         error_msg = illegal_tag (new_tags[i], FALSE);
492         if (error_msg) {
493             fprintf (stderr, "Error: tag '%s' in new.tags: %s\n",
494                      new_tags[i],  error_msg);
495             return EXIT_FAILURE;
496         }
497
498         if (tag_op_list_append (tag_ops, new_tags[i], FALSE))
499             return EXIT_FAILURE;
500     }
501
502     if (parse_tag_command_line (config, argc - opt_index, argv + opt_index,
503                                 &query_string, tag_ops))
504         return EXIT_FAILURE;
505
506     if (*query_string != '\0') {
507         fprintf (stderr, "Error: unexpected query string: %s\n", query_string);
508         return EXIT_FAILURE;
509     }
510
511     if (folder == NULL) {
512         maildir = db_path;
513     } else {
514         if (! is_valid_folder_name (folder)) {
515             fprintf (stderr, "Error: invalid folder name: '%s'\n", folder);
516             return EXIT_FAILURE;
517         }
518         maildir = talloc_asprintf (config, "%s/%s", db_path, folder);
519         if (! maildir) {
520             fprintf (stderr, "Out of memory\n");
521             return EXIT_FAILURE;
522         }
523         if (create_folder && ! maildir_create_folder (config, maildir))
524             return EXIT_FAILURE;
525     }
526
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);
532     action.sa_flags = 0;
533     sigaction (SIGINT, &action, NULL);
534
535     /* Write the message to the Maildir new directory. */
536     newpath = maildir_write_new (config, STDIN_FILENO, maildir);
537     if (! newpath) {
538         return EXIT_FAILURE;
539     }
540
541    if (notmuch_database_open (notmuch_config_get_database_path (config),
542                                NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))
543         return EXIT_FAILURE;
544
545     notmuch_exit_if_unmatched_db_uuid (notmuch);
546
547
548     /* Index the message. */
549     status = add_file (notmuch, newpath, tag_ops, synchronize_flags, keep);
550
551     /* Commit changes. */
552     close_status = notmuch_database_destroy (notmuch);
553     if (close_status) {
554         /* Hold on to the first error, if any. */
555         if (! status)
556             status = close_status;
557         fprintf (stderr, "%s: failed to commit database changes: %s\n",
558                  keep ? "Warning" : "Error",
559                  notmuch_status_to_string (close_status));
560     }
561
562     if (status) {
563         if (keep) {
564             status = NOTMUCH_STATUS_SUCCESS;
565         } else {
566             /* If maildir flag sync failed, this might fail. */
567             if (unlink (newpath)) {
568                 fprintf (stderr, "Warning: failed to remove '%s' from maildir "
569                          "after errors: %s. Please run 'notmuch new' to fix.\n",
570                          newpath, strerror (errno));
571             }
572         }
573     }
574
575     if (! no_hooks && status == NOTMUCH_STATUS_SUCCESS) {
576         /* Ignore hook failures. */
577         notmuch_run_hook (db_path, "post-insert");
578     }
579
580     return status ? EXIT_FAILURE : EXIT_SUCCESS;
581 }