1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see http://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
22 #define _GNU_SOURCE /* for getline */
26 #include <gmime/gmime.h>
30 /* This is separate from notmuch-private.h because we're trying to
31 * keep notmuch.c from looking into any internals, (which helps us
32 * develop notmuch.h into a plausible library interface).
47 #define unused(x) x __attribute__ ((unused))
49 /* There's no point in continuing when we've detected that we've done
50 * something wrong internally (as opposed to the user passing in a
53 * Note that __location__ comes from talloc.h.
55 #define INTERNAL_ERROR(format, ...) \
58 "Internal error: " format " (%s)\n", \
59 ##__VA_ARGS__, __location__); \
63 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
65 typedef int (*command_function_t) (void *ctx, int argc, char *argv[]);
67 typedef struct command {
69 command_function_t function;
71 const char *documentation;
74 typedef void (*add_files_callback_t) (notmuch_message_t *message);
77 int ignore_read_only_directories;
78 int saw_read_only_directory;
83 struct timeval tv_start;
85 add_files_callback_t callback;
89 chomp_newline (char *str)
91 if (str && str[strlen(str)-1] == '\n')
92 str[strlen(str)-1] = '\0';
95 /* Compute the number of seconds elapsed from start to end. */
97 tv_elapsed (struct timeval start, struct timeval end)
99 return ((end.tv_sec - start.tv_sec) +
100 (end.tv_usec - start.tv_usec) / 1e6);
104 print_formatted_seconds (double seconds)
110 printf ("almost no time");
114 if (seconds > 3600) {
115 hours = (int) seconds / 3600;
116 printf ("%dh ", hours);
117 seconds -= hours * 3600;
121 minutes = (int) seconds / 60;
122 printf ("%dm ", minutes);
123 seconds -= minutes * 60;
126 printf ("%ds", (int) seconds);
129 static volatile sig_atomic_t do_add_files_print_progress = 0;
132 handle_sigalrm (unused (int signal))
134 do_add_files_print_progress = 1;
138 add_files_print_progress (add_files_state_t *state)
140 struct timeval tv_now;
141 double elapsed_overall, rate_overall;
143 gettimeofday (&tv_now, NULL);
145 elapsed_overall = tv_elapsed (state->tv_start, tv_now);
146 rate_overall = (state->processed_files) / elapsed_overall;
148 printf ("Processed %d", state->processed_files);
150 if (state->total_files) {
151 printf (" of %d files (", state->total_files);
152 print_formatted_seconds ((state->total_files - state->processed_files) /
154 printf (" remaining). \r");
156 printf (" files (%d files/sec.) \r", (int) rate_overall);
162 /* Examine 'path' recursively as follows:
164 * o Ask the filesystem for the mtime of 'path' (path_mtime)
166 * o Ask the database for its timestamp of 'path' (path_dbtime)
168 * o If 'path_mtime' > 'path_dbtime'
170 * o For each regular file in 'path' with mtime newer than the
171 * 'path_dbtime' call add_message to add the file to the
174 * o For each sub-directory of path, recursively call into this
177 * o Tell the database to update its time of 'path' to 'path_mtime'
179 * The 'struct stat *st' must point to a structure that has already
180 * been initialized for 'path' by calling stat().
182 static notmuch_status_t
183 add_files_recursive (notmuch_database_t *notmuch,
186 add_files_state_t *state)
189 struct dirent *e, *entry = NULL;
193 time_t path_mtime, path_dbtime;
194 notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
195 notmuch_message_t *message = NULL, **closure;
197 /* If we're told to, we bail out on encountering a read-only
198 * directory, (with this being a clear clue from the user to
199 * Notmuch that new mail won't be arriving there and we need not
201 if (state->ignore_read_only_directories &&
202 (st->st_mode & S_IWUSR) == 0)
204 state->saw_read_only_directory = TRUE;
208 path_mtime = st->st_mtime;
210 path_dbtime = notmuch_database_get_timestamp (notmuch, path);
212 dir = opendir (path);
214 fprintf (stderr, "Error opening directory %s: %s\n",
215 path, strerror (errno));
216 ret = NOTMUCH_STATUS_FILE_ERROR;
220 entry_length = offsetof (struct dirent, d_name) +
221 pathconf (path, _PC_NAME_MAX) + 1;
222 entry = malloc (entry_length);
225 err = readdir_r (dir, entry, &e);
227 fprintf (stderr, "Error reading directory: %s\n",
229 ret = NOTMUCH_STATUS_FILE_ERROR;
236 /* If this directory hasn't been modified since the last
237 * add_files, then we only need to look further for
238 * sub-directories. */
239 if (path_mtime <= path_dbtime && entry->d_type != DT_DIR)
242 /* Ignore special directories to avoid infinite recursion.
243 * Also ignore the .notmuch directory.
245 /* XXX: Eventually we'll want more sophistication to let the
246 * user specify files to be ignored. */
247 if (strcmp (entry->d_name, ".") == 0 ||
248 strcmp (entry->d_name, "..") == 0 ||
249 strcmp (entry->d_name, ".notmuch") ==0)
254 next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
256 if (stat (next, st)) {
257 fprintf (stderr, "Error reading %s: %s\n",
258 next, strerror (errno));
259 ret = NOTMUCH_STATUS_FILE_ERROR;
263 if (S_ISREG (st->st_mode)) {
264 /* If the file hasn't been modified since the last
265 * add_files, then we need not look at it. */
266 if (st->st_mtime > path_dbtime) {
267 state->processed_files++;
274 status = notmuch_database_add_message (notmuch, next, closure);
277 case NOTMUCH_STATUS_SUCCESS:
278 state->added_messages++;
280 (state->callback) (message);
282 /* Non-fatal issues (go on to next file) */
283 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
284 /* Stay silent on this one. */
286 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
287 fprintf (stderr, "Note: Ignoring non-mail file: %s\n",
290 /* Fatal issues. Don't process anymore. */
291 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
292 case NOTMUCH_STATUS_OUT_OF_MEMORY:
293 fprintf (stderr, "Error: %s. Halting processing.\n",
294 notmuch_status_to_string (status));
298 case NOTMUCH_STATUS_FILE_ERROR:
299 case NOTMUCH_STATUS_NULL_POINTER:
300 case NOTMUCH_STATUS_TAG_TOO_LONG:
301 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
302 case NOTMUCH_STATUS_LAST_STATUS:
303 INTERNAL_ERROR ("add_message returned unexpected value: %d", status);
308 notmuch_message_destroy (message);
312 if (do_add_files_print_progress) {
313 do_add_files_print_progress = 0;
314 add_files_print_progress (state);
317 } else if (S_ISDIR (st->st_mode)) {
318 status = add_files_recursive (notmuch, next, st, state);
319 if (status && ret == NOTMUCH_STATUS_SUCCESS)
327 status = notmuch_database_set_timestamp (notmuch, path, path_mtime);
328 if (status && ret == NOTMUCH_STATUS_SUCCESS)
342 /* This is the top-level entry point for add_files. It does a couple
343 * of error checks, sets up the progress-printing timer and then calls
344 * into the recursive function. */
345 static notmuch_status_t
346 add_files (notmuch_database_t *notmuch,
348 add_files_state_t *state)
351 notmuch_status_t status;
352 struct sigaction action;
353 struct itimerval timerval;
355 if (stat (path, &st)) {
356 fprintf (stderr, "Error reading directory %s: %s\n",
357 path, strerror (errno));
358 return NOTMUCH_STATUS_FILE_ERROR;
361 if (! S_ISDIR (st.st_mode)) {
362 fprintf (stderr, "Error: %s is not a directory.\n", path);
363 return NOTMUCH_STATUS_FILE_ERROR;
366 /* Setup our handler for SIGALRM */
367 memset (&action, 0, sizeof (struct sigaction));
368 action.sa_handler = handle_sigalrm;
369 sigemptyset (&action.sa_mask);
370 action.sa_flags = SA_RESTART;
371 sigaction (SIGALRM, &action, NULL);
373 /* Then start a timer to send SIGALRM once per second. */
374 timerval.it_interval.tv_sec = 1;
375 timerval.it_interval.tv_usec = 0;
376 timerval.it_value.tv_sec = 1;
377 timerval.it_value.tv_usec = 0;
378 setitimer (ITIMER_REAL, &timerval, NULL);
380 status = add_files_recursive (notmuch, path, &st, state);
382 /* Now stop the timer. */
383 timerval.it_interval.tv_sec = 0;
384 timerval.it_interval.tv_usec = 0;
385 timerval.it_value.tv_sec = 0;
386 timerval.it_value.tv_usec = 0;
387 setitimer (ITIMER_REAL, &timerval, NULL);
389 /* And disable the signal handler. */
390 action.sa_handler = SIG_IGN;
391 sigaction (SIGALRM, &action, NULL);
396 /* Recursively count all regular files in path and all sub-direcotries
397 * of path. The result is added to *count (which should be
398 * initialized to zero by the top-level caller before calling
401 count_files (const char *path, int *count)
404 struct dirent *e, *entry = NULL;
410 dir = opendir (path);
413 fprintf (stderr, "Warning: failed to open directory %s: %s\n",
414 path, strerror (errno));
418 entry_length = offsetof (struct dirent, d_name) +
419 pathconf (path, _PC_NAME_MAX) + 1;
420 entry = malloc (entry_length);
423 err = readdir_r (dir, entry, &e);
425 fprintf (stderr, "Error reading directory: %s\n",
434 /* Ignore special directories to avoid infinite recursion.
435 * Also ignore the .notmuch directory.
437 /* XXX: Eventually we'll want more sophistication to let the
438 * user specify files to be ignored. */
439 if (strcmp (entry->d_name, ".") == 0 ||
440 strcmp (entry->d_name, "..") == 0 ||
441 strcmp (entry->d_name, ".notmuch") == 0)
446 if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
448 fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
449 path, entry->d_name);
455 if (S_ISREG (st.st_mode)) {
457 if (*count % 1000 == 0) {
458 printf ("Found %d files so far.\r", *count);
461 } else if (S_ISDIR (st.st_mode)) {
462 count_files (next, count);
476 setup_command (unused (void *ctx), unused (int argc), unused (char *argv[]))
478 notmuch_database_t *notmuch = NULL;
479 char *default_path, *mail_directory = NULL;
482 add_files_state_t add_files_state;
484 struct timeval tv_now;
485 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
487 printf ("Welcome to notmuch!\n\n");
489 printf ("The goal of notmuch is to help you manage and search your collection of\n"
490 "email, and to efficiently keep up with the flow of email as it comes in.\n\n");
492 printf ("Notmuch needs to know the top-level directory of your email archive,\n"
493 "(where you already have mail stored and where messages will be delivered\n"
494 "in the future). This directory can contain any number of sub-directories\n"
495 "and primarily just files with indvidual email messages (eg. maildir or mh\n"
496 "archives are perfect). If there are other, non-email files (such as\n"
497 "indexes maintained by other email programs) then notmuch will do its\n"
498 "best to detect those and ignore them.\n\n");
500 printf ("Mail storage that uses mbox format, (where one mbox file contains many\n"
501 "messages), will not work with notmuch. If that's how your mail is currently\n"
502 "stored, we recommend you first convert it to maildir format with a utility\n"
503 "such as mb2md. In that case, press Control-C now and run notmuch again\n"
504 "once the conversion is complete.\n\n");
507 default_path = notmuch_database_default_path ();
508 printf ("Top-level mail directory [%s]: ", default_path);
511 getline (&mail_directory, &line_size, stdin);
512 chomp_newline (mail_directory);
516 if (mail_directory == NULL || strlen (mail_directory) == 0) {
518 free (mail_directory);
519 mail_directory = default_path;
521 /* XXX: Instead of telling the user to use an environment
522 * variable here, we should really be writing out a configuration
523 * file and loading that on the next run. */
524 if (strcmp (mail_directory, default_path)) {
525 printf ("Note: Since you are not using the default path, you will want to set\n"
526 "the NOTMUCH_BASE environment variable to %s so that\n"
527 "future calls to notmuch commands will know where to find your mail.\n",
529 printf ("For example, if you are using bash for your shell, add:\n\n");
530 printf ("\texport NOTMUCH_BASE=%s\n\n", mail_directory);
531 printf ("to your ~/.bashrc file.\n\n");
536 /* Coerce th directory into an absolute directory name. */
537 if (*mail_directory != '/') {
538 char *cwd, *absolute_mail_directory;
540 cwd = getcwd (NULL, 0);
542 fprintf (stderr, "Out of memory.\n");
546 if (asprintf (&absolute_mail_directory, "%s/%s",
547 cwd, mail_directory) < 0)
549 fprintf (stderr, "Out of memory.\n");
554 free (mail_directory);
555 mail_directory = absolute_mail_directory;
557 printf ("Abs: %s\n", mail_directory);
560 notmuch = notmuch_database_create (mail_directory);
561 if (notmuch == NULL) {
562 fprintf (stderr, "Failed to create new notmuch database at %s\n",
564 ret = NOTMUCH_STATUS_FILE_ERROR;
568 printf ("OK. Let's take a look at the mail we can find in the directory\n");
569 printf ("%s ...\n", mail_directory);
572 count_files (mail_directory, &count);
574 printf ("Found %d total files. That's not much mail.\n\n", count);
576 printf ("Next, we'll inspect the messages and create a database of threads:\n");
578 add_files_state.ignore_read_only_directories = FALSE;
579 add_files_state.saw_read_only_directory = FALSE;
580 add_files_state.total_files = count;
581 add_files_state.processed_files = 0;
582 add_files_state.added_messages = 0;
583 add_files_state.callback = NULL;
584 gettimeofday (&add_files_state.tv_start, NULL);
586 ret = add_files (notmuch, mail_directory, &add_files_state);
588 gettimeofday (&tv_now, NULL);
589 elapsed = tv_elapsed (add_files_state.tv_start,
591 printf ("Processed %d %s in ", add_files_state.processed_files,
592 add_files_state.processed_files == 1 ?
593 "file" : "total files");
594 print_formatted_seconds (elapsed);
596 printf (" (%d files/sec.). \n",
597 (int) (add_files_state.processed_files / elapsed));
601 if (add_files_state.added_messages) {
602 printf ("Added %d %s to the database.\n\n",
603 add_files_state.added_messages,
604 add_files_state.added_messages == 1 ?
605 "message" : "unique messages");
608 printf ("When new mail is delivered to %s in the future,\n"
609 "run \"notmuch new\" to add it to the database.\n\n",
613 printf ("Note: At least one error was encountered: %s\n",
614 notmuch_status_to_string (ret));
619 free (mail_directory);
621 notmuch_database_close (notmuch);
627 tag_inbox_and_unread (notmuch_message_t *message)
629 notmuch_message_add_tag (message, "inbox");
630 notmuch_message_add_tag (message, "unread");
634 new_command (unused (void *ctx), unused (int argc), unused (char *argv[]))
636 notmuch_database_t *notmuch;
637 const char *mail_directory;
638 add_files_state_t add_files_state;
640 struct timeval tv_now;
643 notmuch = notmuch_database_open (NULL);
644 if (notmuch == NULL) {
649 mail_directory = notmuch_database_get_path (notmuch);
651 add_files_state.ignore_read_only_directories = TRUE;
652 add_files_state.saw_read_only_directory = FALSE;
653 add_files_state.total_files = 0;
654 add_files_state.processed_files = 0;
655 add_files_state.added_messages = 0;
656 add_files_state.callback = tag_inbox_and_unread;
657 gettimeofday (&add_files_state.tv_start, NULL);
659 ret = add_files (notmuch, mail_directory, &add_files_state);
661 gettimeofday (&tv_now, NULL);
662 elapsed = tv_elapsed (add_files_state.tv_start,
664 if (add_files_state.processed_files) {
665 printf ("Processed %d %s in ", add_files_state.processed_files,
666 add_files_state.processed_files == 1 ?
667 "file" : "total files");
668 print_formatted_seconds (elapsed);
670 printf (" (%d files/sec.). \n",
671 (int) (add_files_state.processed_files / elapsed));
676 if (add_files_state.added_messages) {
677 printf ("Added %d new %s to the database (not much, really).\n",
678 add_files_state.added_messages,
679 add_files_state.added_messages == 1 ?
680 "message" : "messages");
682 printf ("No new mail---and that's not much.\n");
685 if (elapsed > 1 && ! add_files_state.saw_read_only_directory) {
686 printf ("\nTip: If you have any sub-directories that are archives (that is,\n"
687 "they will never receive new mail), marking these directores as\n"
688 "read-only (chmod u-w /path/to/dir) will make \"notmuch new\"\n"
689 "much more efficient (it won't even look in those directories).\n");
693 printf ("\nNote: At least one error was encountered: %s\n",
694 notmuch_status_to_string (ret));
699 notmuch_database_close (notmuch);
704 /* Construct a single query string from the passed arguments, using
705 * 'ctx' as the talloc owner for all allocations.
707 * Currently, the arguments are just connected with space characters,
708 * but we might do more processing in the future, (such as inserting
709 * any AND operators needed to work around Xapian QueryParser bugs).
711 * This function returns NULL in case of insufficient memory.
714 query_string_from_args (void *ctx, int argc, char *argv[])
719 query_string = talloc_strdup (ctx, "");
720 if (query_string == NULL)
723 for (i = 0; i < argc; i++) {
725 query_string = talloc_strdup_append (query_string, " ");
726 if (query_string == NULL)
730 query_string = talloc_strdup_append (query_string, argv[i]);
731 if (query_string == NULL)
738 /* Format a nice representation of 'time' relative to the current time.
742 * 5 minutes ago (For times less than 60 minutes ago)
743 * 12:30 (For times >60 minutes but still today)
745 * Monday (Before yesterday but fewer than 7 days ago)
746 * Oct. 12 (Between 7 and 180 days ago (about 6 months))
747 * 2008-06-30 (More than 180 days ago)
750 #define HOUR (60 * MINUTE)
751 #define DAY (24 * HOUR)
752 #define RELATIVE_DATE_MAX 20
754 _format_relative_date (void *ctx, time_t then)
756 struct tm tm_now, tm_then;
757 time_t now = time(NULL);
761 localtime_r (&now, &tm_now);
762 localtime_r (&then, &tm_then);
764 result = talloc_zero_size (ctx, RELATIVE_DATE_MAX);
773 if (delta > 180 * DAY) {
774 strftime (result, RELATIVE_DATE_MAX,
775 "%F", &tm_then); /* 2008-06-30 */
780 snprintf (result, RELATIVE_DATE_MAX,
781 "%d minutes ago", (int) (delta / 60));
785 if (delta <= 7 * DAY) {
786 if (tm_then.tm_wday == tm_now.tm_wday &&
789 strftime (result, RELATIVE_DATE_MAX,
790 "%R", &tm_then); /* 12:30 */
792 } else if ((tm_now.tm_wday + 7 - tm_then.tm_wday) % 7 == 1) {
795 if (tm_then.tm_wday != tm_now.tm_wday) {
796 strftime (result, RELATIVE_DATE_MAX,
797 "%A", &tm_then); /* Monday */
803 strftime (result, RELATIVE_DATE_MAX,
804 "%b %d", &tm_then); /* Oct. 12 */
812 search_command (void *ctx, int argc, char *argv[])
814 void *local = talloc_new (ctx);
815 notmuch_database_t *notmuch = NULL;
816 notmuch_query_t *query;
817 notmuch_threads_t *threads;
818 notmuch_thread_t *thread;
819 notmuch_tags_t *tags;
821 const char *relative_date;
823 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
825 notmuch = notmuch_database_open (NULL);
826 if (notmuch == NULL) {
831 query_str = query_string_from_args (local, argc, argv);
833 query = notmuch_query_create (notmuch, query_str);
835 fprintf (stderr, "Out of memory\n");
840 for (threads = notmuch_query_search_threads (query);
841 notmuch_threads_has_more (threads);
842 notmuch_threads_advance (threads))
846 thread = notmuch_threads_get (threads);
848 date = notmuch_thread_get_oldest_date (thread);
849 relative_date = _format_relative_date (local, date);
851 printf ("%s (%s) %s",
852 notmuch_thread_get_thread_id (thread),
854 notmuch_thread_get_subject (thread));
857 for (tags = notmuch_thread_get_tags (thread);
858 notmuch_tags_has_more (tags);
859 notmuch_tags_advance (tags))
863 printf ("%s", notmuch_tags_get (tags));
868 notmuch_thread_destroy (thread);
871 notmuch_query_destroy (query);
875 notmuch_database_close (notmuch);
881 /* Get a nice, single-line summary of message. */
883 _get_one_line_summary (void *ctx, notmuch_message_t *message)
887 const char *relative_date;
890 from = notmuch_message_get_header (message, "from");
892 date = notmuch_message_get_date (message);
893 relative_date = _format_relative_date (ctx, date);
895 subject = notmuch_message_get_header (message, "subject");
897 return talloc_asprintf (ctx, "%s (%s) %s",
898 from, relative_date, subject);
902 show_message_part (GMimeObject *part)
905 GMimeDataWrapper *wrapper;
906 GMimeContentDisposition *disposition;
908 if (GMIME_IS_MULTIPART (part)) {
909 GMimeMultipart *multipart = GMIME_MULTIPART (part);
912 for (i = 0; i < g_mime_multipart_get_count (multipart); i++) {
913 if (GMIME_IS_MULTIPART_SIGNED (multipart)) {
914 /* Don't index the signature. */
918 fprintf (stderr, "Warning: Unexpected extra parts of mutlipart/signed. Continuing.\n");
920 show_message_part (g_mime_multipart_get_part (multipart, i));
925 if (GMIME_IS_MESSAGE_PART (part)) {
926 GMimeMessage *mime_message;
928 mime_message = g_mime_message_part_get_message (GMIME_MESSAGE_PART (part));
930 show_message_part (g_mime_message_get_mime_part (mime_message));
935 if (! (GMIME_IS_PART (part))) {
936 fprintf (stderr, "Warning: Not displaying unknown mime part: %s.\n",
937 g_type_name (G_OBJECT_TYPE (part)));
941 disposition = g_mime_object_get_content_disposition (part);
943 strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
945 const char *filename = g_mime_part_get_filename (GMIME_PART (part));
947 /* XXX: Need to print content type here as well. */
948 printf ("%%attachment{ %s %%attachment}\n", filename);
952 /* Stream the MIME part out to stdout. */
953 stream = g_mime_stream_file_new (stdout);
954 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream), FALSE);
956 wrapper = g_mime_part_get_content_object (GMIME_PART (part));
958 g_mime_data_wrapper_write_to_stream (wrapper, stream);
960 g_object_unref (stream);
963 static notmuch_status_t
964 show_message_body (const char *filename)
966 GMimeStream *stream = NULL;
967 GMimeParser *parser = NULL;
968 GMimeMessage *mime_message = NULL;
969 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
970 static int initialized = 0;
978 file = fopen (filename, "r");
980 fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));
981 ret = NOTMUCH_STATUS_FILE_ERROR;
985 stream = g_mime_stream_file_new (file);
986 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream), FALSE);
988 parser = g_mime_parser_new_with_stream (stream);
990 mime_message = g_mime_parser_construct_message (parser);
992 show_message_part (g_mime_message_get_mime_part (mime_message));
996 g_object_unref (mime_message);
999 g_object_unref (parser);
1002 g_object_unref (stream);
1011 show_command (void *ctx, unused (int argc), unused (char *argv[]))
1013 void *local = talloc_new (ctx);
1015 notmuch_database_t *notmuch = NULL;
1016 notmuch_query_t *query = NULL;
1017 notmuch_messages_t *messages;
1018 notmuch_message_t *message;
1021 const char *headers[] = {
1022 "Subject", "From", "To", "Cc", "Bcc", "Date"
1024 const char *name, *value;
1028 fprintf (stderr, "Error: \"notmuch show\" requires exactly one thread-ID argument.\n");
1033 notmuch = notmuch_database_open (NULL);
1034 if (notmuch == NULL) {
1039 query_string = talloc_asprintf (local, "thread:%s", argv[0]);
1040 if (query_string == NULL) {
1041 fprintf (stderr, "Out of memory\n");
1046 query = notmuch_query_create (notmuch, query_string);
1047 if (query == NULL) {
1048 fprintf (stderr, "Out of memory\n");
1053 for (messages = notmuch_query_search_messages (query);
1054 notmuch_messages_has_more (messages);
1055 notmuch_messages_advance (messages))
1057 message = notmuch_messages_get (messages);
1059 printf ("%%message{\n");
1061 printf ("%%header{\n");
1063 printf ("%s\n", _get_one_line_summary (local, message));
1065 for (i = 0; i < ARRAY_SIZE (headers); i++) {
1067 value = notmuch_message_get_header (message, name);
1069 printf ("%s: %s\n", name, value);
1072 printf ("%%header}\n");
1074 show_message_body (notmuch_message_get_filename (message));
1076 printf ("%%message}\n");
1078 notmuch_message_destroy (message);
1083 talloc_free (local);
1086 notmuch_query_destroy (query);
1089 notmuch_database_close (notmuch);
1095 tag_command (void *ctx, unused (int argc), unused (char *argv[]))
1098 int *add_tags, *remove_tags;
1099 int add_tags_count = 0;
1100 int remove_tags_count = 0;
1102 notmuch_database_t *notmuch = NULL;
1103 notmuch_query_t *query;
1104 notmuch_messages_t *messages;
1105 notmuch_message_t *message;
1109 local = talloc_new (ctx);
1110 if (local == NULL) {
1115 add_tags = talloc_size (local, argc * sizeof (int));
1116 if (add_tags == NULL) {
1121 remove_tags = talloc_size (local, argc * sizeof (int));
1122 if (remove_tags == NULL) {
1127 for (i = 0; i < argc; i++) {
1128 if (strcmp (argv[i], "--") == 0) {
1132 if (argv[i][0] == '+') {
1133 add_tags[add_tags_count++] = i;
1134 } else if (argv[i][0] == '-') {
1135 remove_tags[remove_tags_count++] = i;
1141 if (add_tags_count == 0 && remove_tags_count == 0) {
1142 fprintf (stderr, "Error: 'notmuch tag' requires at least one tag to add or remove.\n");
1148 fprintf (stderr, "Error: 'notmuch tag' requires at least one search term.\n");
1153 notmuch = notmuch_database_open (NULL);
1154 if (notmuch == NULL) {
1159 query_string = query_string_from_args (local, argc - i, &argv[i]);
1161 query = notmuch_query_create (notmuch, query_string);
1162 if (query == NULL) {
1163 fprintf (stderr, "Out of memory.\n");
1168 for (messages = notmuch_query_search_messages (query);
1169 notmuch_messages_has_more (messages);
1170 notmuch_messages_advance (messages))
1172 message = notmuch_messages_get (messages);
1174 notmuch_message_freeze (message);
1176 for (i = 0; i < remove_tags_count; i++)
1177 notmuch_message_remove_tag (message,
1178 argv[remove_tags[i]] + 1);
1180 for (i = 0; i < add_tags_count; i++)
1181 notmuch_message_add_tag (message, argv[add_tags[i]] + 1);
1183 notmuch_message_thaw (message);
1185 notmuch_message_destroy (message);
1188 notmuch_query_destroy (query);
1192 notmuch_database_close (notmuch);
1194 talloc_free (local);
1200 dump_command (unused (void *ctx), int argc, char *argv[])
1202 FILE *output = NULL;
1203 notmuch_database_t *notmuch = NULL;
1204 notmuch_query_t *query;
1205 notmuch_messages_t *messages;
1206 notmuch_message_t *message;
1207 notmuch_tags_t *tags;
1211 output = fopen (argv[0], "w");
1212 if (output == NULL) {
1213 fprintf (stderr, "Error opening %s for writing: %s\n",
1214 argv[0], strerror (errno));
1222 notmuch = notmuch_database_open (NULL);
1223 if (notmuch == NULL) {
1228 query = notmuch_query_create (notmuch, "");
1229 if (query == NULL) {
1230 fprintf (stderr, "Out of memory\n");
1235 notmuch_query_set_sort (query, NOTMUCH_SORT_MESSAGE_ID);
1237 for (messages = notmuch_query_search_messages (query);
1238 notmuch_messages_has_more (messages);
1239 notmuch_messages_advance (messages))
1242 message = notmuch_messages_get (messages);
1245 "%s (", notmuch_message_get_message_id (message));
1247 for (tags = notmuch_message_get_tags (message);
1248 notmuch_tags_has_more (tags);
1249 notmuch_tags_advance (tags))
1252 fprintf (output, " ");
1254 fprintf (output, "%s", notmuch_tags_get (tags));
1259 fprintf (output, ")\n");
1261 notmuch_message_destroy (message);
1264 notmuch_query_destroy (query);
1268 notmuch_database_close (notmuch);
1269 if (output && output != stdout)
1276 restore_command (unused (void *ctx), int argc, char *argv[])
1279 notmuch_database_t *notmuch = NULL;
1288 input = fopen (argv[0], "r");
1289 if (input == NULL) {
1290 fprintf (stderr, "Error opening %s for reading: %s\n",
1291 argv[0], strerror (errno));
1296 printf ("No filename given. Reading dump from stdin.\n");
1300 notmuch = notmuch_database_open (NULL);
1301 if (notmuch == NULL) {
1306 /* Dump output is one line per message. We match a sequence of
1307 * non-space characters for the message-id, then one or more
1308 * spaces, then a list of space-separated tags as a sequence of
1309 * characters within literal '(' and ')'. */
1311 "^([^ ]+) \\(([^)]*)\\)$",
1314 while ((line_len = getline (&line, &line_size, input)) != -1) {
1315 regmatch_t match[3];
1316 char *message_id, *tags, *tag, *next;
1317 notmuch_message_t *message;
1318 notmuch_status_t status;
1320 chomp_newline (line);
1322 rerr = xregexec (®ex, line, 3, match, 0);
1323 if (rerr == REG_NOMATCH)
1325 fprintf (stderr, "Warning: Ignoring invalid input line: %s\n",
1330 message_id = xstrndup (line + match[1].rm_so,
1331 match[1].rm_eo - match[1].rm_so);
1332 tags = xstrndup (line + match[2].rm_so,
1333 match[2].rm_eo - match[2].rm_so);
1335 if (strlen (tags)) {
1337 message = notmuch_database_find_message (notmuch, message_id);
1338 if (message == NULL) {
1339 fprintf (stderr, "Warning: Cannot apply tags to missing message: %s\n",
1344 notmuch_message_freeze (message);
1346 notmuch_message_remove_all_tags (message);
1350 tag = strsep (&next, " ");
1353 status = notmuch_message_add_tag (message, tag);
1356 "Error applying tag %s to message %s:\n",
1358 fprintf (stderr, "%s\n",
1359 notmuch_status_to_string (status));
1363 notmuch_message_thaw (message);
1364 notmuch_message_destroy (message);
1377 notmuch_database_close (notmuch);
1378 if (input && input != stdin)
1385 help_command (void *ctx, int argc, char *argv[]);
1387 command_t commands[] = {
1388 { "setup", setup_command,
1389 "Interactively setup notmuch for first use.",
1390 "\t\tThe setup command is the first command you will run in order\n"
1391 "\t\tto start using notmuch. It will prompt you for the directory\n"
1392 "\t\tcontaining your email archives, and will then proceed to build\n"
1393 "\t\ta database to allow fast searching of that mail.\n\n"
1394 "\t\tInvoking notmuch with no command argument will run setup if\n"
1395 "\t\tthe setup command has not previously been completed." },
1396 { "new", new_command,
1397 "Find and import any new messages.",
1398 "\t\tScans all sub-directories of the database, adding new messages\n"
1399 "\t\tthat are found. Each new message will be tagged as both\n"
1400 "\t\t\"inbox\" and \"unread\".\n"
1402 "\t\tNote: \"notmuch new\" will skip any read-only directories,\n"
1403 "\t\tso you can use that to mark directories that will not\n"
1404 "\t\treceive any new mail (and make \"notmuch new\" faster)." },
1405 { "search", search_command,
1406 "<search-term> [...]\n\n"
1407 "\t\tSearch for threads matching the given search terms.",
1408 "\t\tNote that the individual mail messages will be matched\n"
1409 "\t\tagainst the search terms, but the results will be the\n"
1410 "\t\tthreads containing the matched messages.\n\n"
1411 "\t\tCurrently, the supported search terms are as follows, (where\n"
1412 "\t\t<brackets> indicate user-supplied values):\n\n"
1414 "\t\t\tid:<message-id>\n"
1415 "\t\t\tthread:<thread-id>\n\n"
1416 "\t\tValid tag values include \"inbox\" and \"unread\" by default\n"
1417 "\t\tfor new messages added by \"notmuch new\" as well as any other\n"
1418 "\t\ttag values added manually with \"notmuch tag\".\n\n"
1419 "\t\tMessage ID values are the literal contents of the Message-ID:\n"
1420 "\t\theader of email messages, but without the '<','>' delimiters.\n\n"
1421 "\t\tThread ID values are generated internally by notmuch but can\n"
1422 "\t\tbe seen in the output of \"notmuch search\" for example.\n\n"
1423 "\t\tIn addition to individual terms, multiple terms can be\n"
1424 "\t\tcombined with Boolean operators (\"and\", \"or\", \"not\", etc.).\n"
1425 "\t\tEach term in the query will be implicitly connected by a\n"
1426 "\t\tlogical AND if no explicit operator is provided, (except\n"
1427 "\t\tthat terms with a common prefix will be implicitly combined\n"
1428 "\t\twith OR until we get Xapian defect #402 fixed).\n\n"
1429 "\t\tParentheses can also be used to control the combination of\n"
1430 "\t\tthe Boolean operators, but will have to be protected from\n"
1431 "\t\tinterpretation by the shell, (such as by putting quotation\n"
1432 "\t\tmarks around any parenthesized expression)." },
1433 { "show", show_command,
1435 "\t\tShow the thread with the given thread ID (see 'search').",
1436 "\t\tThread ID values are given as the first column in the\n"
1437 "\t\toutput of the \"notmuch search\" command. These are the\n"
1438 "\t\trandom-looking strings of 32 characters." },
1439 { "tag", tag_command,
1440 "+<tag>|-<tag> [...] [--] <search-term> [...]\n\n"
1441 "\t\tAdd/remove tags for all messages matching the search terms.",
1442 "\t\tThe search terms are handled exactly as in 'search' so one\n"
1443 "\t\tcan use that command first to see what will be modified.\n\n"
1444 "\t\tTags prefixed by '+' are added while those prefixed by '-' are\n"
1445 "\t\tremoved. For each message, tag removal is before tag addition.\n\n"
1446 "\t\tThe beginning of <search-terms> is recognized by the first\n"
1447 "\t\targument that begins with neither '+' nor '-'. Support for\n"
1448 "\t\tan initial search term beginning with '+' or '-' is provided\n"
1449 "\t\tby allowing the user to specify a \"--\" argument to separate\n"
1450 "\t\tthe tags from the search terms.\n\n"
1451 "\t\tNote: If you run \"notmuch new\" between reading a thread with\n"
1452 "\t\t\"notmuch show\" and removing the \"inbox\" tag for that thread\n"
1453 "\t\twith \"notmuch tag\" then you create the possibility of moving\n"
1454 "\t\tsome messages from that thread out of your inbox without ever\n"
1455 "\t\treading them. The easiest way to avoid this problem is to not\n"
1456 "\t\trun \"notmuch new\" between reading and removing tags." },
1457 { "dump", dump_command,
1459 "\t\tCreate a plain-text dump of the tags for each message.",
1460 "\t\tOutput is to the given filename, if any, or to stdout.\n"
1461 "\t\tThese tags are the only data in the notmuch database\n"
1462 "\t\tthat can't be recreated from the messages themselves.\n"
1463 "\t\tThe output of notmuch dump is therefore the only\n"
1464 "\t\tcritical thing to backup (and much more friendly to\n"
1465 "\t\tincremental backup than the native database files.)" },
1466 { "restore", restore_command,
1468 "\t\tRestore the tags from the given dump file (see 'dump').",
1469 "\t\tNote: The dump file format is specifically chosen to be\n"
1470 "\t\tcompatible with the format of files produced by sup-dump.\n"
1471 "\t\tSo if you've previously been using sup for mail, then the\n"
1472 "\t\t\"notmuch restore\" command provides you a way to import\n"
1473 "\t\tall of your tags (or labels as sup calls them)." },
1474 { "help", help_command,
1476 "\t\tThis message, or more detailed help for the named command.",
1477 "\t\tExcept in this case, where there's not much more detailed\n"
1478 "\t\thelp available." }
1487 fprintf (stderr, "Usage: notmuch <command> [args...]\n");
1488 fprintf (stderr, "\n");
1489 fprintf (stderr, "Where <command> and [args...] are as follows:\n");
1490 fprintf (stderr, "\n");
1492 for (i = 0; i < ARRAY_SIZE (commands); i++) {
1493 command = &commands[i];
1495 fprintf (stderr, "\t%s\t%s\n\n", command->name, command->summary);
1498 fprintf (stderr, "Use \"notmuch help <command>\" for more details on each command.\n\n");
1502 help_command (unused (void *ctx), int argc, char *argv[])
1508 fprintf (stderr, "The notmuch mail system.\n\n");
1513 for (i = 0; i < ARRAY_SIZE (commands); i++) {
1514 command = &commands[i];
1516 if (strcmp (argv[0], command->name) == 0) {
1517 fprintf (stderr, "Help for \"notmuch %s\":\n\n", argv[0]);
1518 fprintf (stderr, "\t%s\t%s\n\n%s\n\n", command->name,
1519 command->summary, command->documentation);
1525 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
1531 main (int argc, char *argv[])
1533 void *local = talloc_new (NULL);
1538 return setup_command (local, 0, NULL);
1540 for (i = 0; i < ARRAY_SIZE (commands); i++) {
1541 command = &commands[i];
1543 if (strcmp (argv[1], command->name) == 0)
1544 return (command->function) (local, argc - 2, &argv[2]);
1547 /* Don't complain about "help" being an unknown command when we're
1548 about to provide exactly what's wanted anyway. */
1549 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
1552 talloc_free (local);