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 */
28 /* This is separate from notmuch-private.h because we're trying to
29 * keep notmuch.c from looking into any internals, (which helps us
30 * develop notmuch.h into a plausible library interface).
45 #define unused(x) x __attribute__ ((unused))
47 /* There's no point in continuing when we've detected that we've done
48 * something wrong internally (as opposed to the user passing in a
51 * Note that __location__ comes from talloc.h.
53 #define INTERNAL_ERROR(format, ...) \
56 "Internal error: " format " (%s)\n", \
57 ##__VA_ARGS__, __location__); \
61 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
63 typedef int (*command_function_t) (int argc, char *argv[]);
65 typedef struct command {
67 command_function_t function;
69 const char *documentation;
72 typedef void (*add_files_callback_t) (notmuch_message_t *message);
75 int ignore_read_only_directories;
76 int saw_read_only_directory;
81 struct timeval tv_start;
83 add_files_callback_t callback;
87 chomp_newline (char *str)
89 if (str && str[strlen(str)-1] == '\n')
90 str[strlen(str)-1] = '\0';
93 /* Compute the number of seconds elapsed from start to end. */
95 tv_elapsed (struct timeval start, struct timeval end)
97 return ((end.tv_sec - start.tv_sec) +
98 (end.tv_usec - start.tv_usec) / 1e6);
102 print_formatted_seconds (double seconds)
108 printf ("almost no time");
112 if (seconds > 3600) {
113 hours = (int) seconds / 3600;
114 printf ("%dh ", hours);
115 seconds -= hours * 3600;
119 minutes = (int) seconds / 60;
120 printf ("%dm ", minutes);
121 seconds -= minutes * 60;
124 printf ("%ds", (int) seconds);
127 static volatile sig_atomic_t do_add_files_print_progress = 0;
130 handle_sigalrm (unused (int signal))
132 do_add_files_print_progress = 1;
136 add_files_print_progress (add_files_state_t *state)
138 struct timeval tv_now;
139 double elapsed_overall, rate_overall;
141 gettimeofday (&tv_now, NULL);
143 elapsed_overall = tv_elapsed (state->tv_start, tv_now);
144 rate_overall = (state->processed_files) / elapsed_overall;
146 printf ("Processed %d", state->processed_files);
148 if (state->total_files) {
149 printf (" of %d files (", state->total_files);
150 print_formatted_seconds ((state->total_files - state->processed_files) /
152 printf (" remaining). \r");
154 printf (" files (%d files/sec.) \r", (int) rate_overall);
160 /* Examine 'path' recursively as follows:
162 * o Ask the filesystem for the mtime of 'path' (path_mtime)
164 * o Ask the database for its timestamp of 'path' (path_dbtime)
166 * o If 'path_mtime' > 'path_dbtime'
168 * o For each regular file in 'path' with mtime newer than the
169 * 'path_dbtime' call add_message to add the file to the
172 * o For each sub-directory of path, recursively call into this
175 * o Tell the database to update its time of 'path' to 'path_mtime'
177 * The 'struct stat *st' must point to a structure that has already
178 * been initialized for 'path' by calling stat().
180 static notmuch_status_t
181 add_files_recursive (notmuch_database_t *notmuch,
184 add_files_state_t *state)
187 struct dirent *e, *entry = NULL;
191 time_t path_mtime, path_dbtime;
192 notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
193 notmuch_message_t *message = NULL, **closure;
195 /* If we're told to, we bail out on encountering a read-only
196 * directory, (with this being a clear clue from the user to
197 * Notmuch that new mail won't be arriving there and we need not
199 if (state->ignore_read_only_directories &&
200 (st->st_mode & S_IWUSR) == 0)
202 state->saw_read_only_directory = TRUE;
206 path_mtime = st->st_mtime;
208 path_dbtime = notmuch_database_get_timestamp (notmuch, path);
210 dir = opendir (path);
212 fprintf (stderr, "Error opening directory %s: %s\n",
213 path, strerror (errno));
214 ret = NOTMUCH_STATUS_FILE_ERROR;
218 entry_length = offsetof (struct dirent, d_name) +
219 pathconf (path, _PC_NAME_MAX) + 1;
220 entry = malloc (entry_length);
223 err = readdir_r (dir, entry, &e);
225 fprintf (stderr, "Error reading directory: %s\n",
227 ret = NOTMUCH_STATUS_FILE_ERROR;
234 /* If this directory hasn't been modified since the last
235 * add_files, then we only need to look further for
236 * sub-directories. */
237 if (path_mtime <= path_dbtime && entry->d_type != DT_DIR)
240 /* Ignore special directories to avoid infinite recursion.
241 * Also ignore the .notmuch directory.
243 /* XXX: Eventually we'll want more sophistication to let the
244 * user specify files to be ignored. */
245 if (strcmp (entry->d_name, ".") == 0 ||
246 strcmp (entry->d_name, "..") == 0 ||
247 strcmp (entry->d_name, ".notmuch") ==0)
252 next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
254 if (stat (next, st)) {
255 fprintf (stderr, "Error reading %s: %s\n",
256 next, strerror (errno));
257 ret = NOTMUCH_STATUS_FILE_ERROR;
261 if (S_ISREG (st->st_mode)) {
262 /* If the file hasn't been modified since the last
263 * add_files, then we need not look at it. */
264 if (st->st_mtime > path_dbtime) {
265 state->processed_files++;
272 status = notmuch_database_add_message (notmuch, next, closure);
275 case NOTMUCH_STATUS_SUCCESS:
276 state->added_messages++;
278 (state->callback) (message);
280 /* Non-fatal issues (go on to next file) */
281 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
282 /* Stay silent on this one. */
284 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
285 fprintf (stderr, "Note: Ignoring non-mail file: %s\n",
288 /* Fatal issues. Don't process anymore. */
289 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
290 case NOTMUCH_STATUS_OUT_OF_MEMORY:
291 fprintf (stderr, "Error: %s. Halting processing.\n",
292 notmuch_status_to_string (status));
296 case NOTMUCH_STATUS_FILE_ERROR:
297 case NOTMUCH_STATUS_NULL_POINTER:
298 case NOTMUCH_STATUS_TAG_TOO_LONG:
299 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
300 case NOTMUCH_STATUS_LAST_STATUS:
301 INTERNAL_ERROR ("add_message returned unexpected value: %d", status);
306 notmuch_message_destroy (message);
310 if (do_add_files_print_progress) {
311 do_add_files_print_progress = 0;
312 add_files_print_progress (state);
315 } else if (S_ISDIR (st->st_mode)) {
316 status = add_files_recursive (notmuch, next, st, state);
317 if (status && ret == NOTMUCH_STATUS_SUCCESS)
325 status = notmuch_database_set_timestamp (notmuch, path, path_mtime);
326 if (status && ret == NOTMUCH_STATUS_SUCCESS)
340 /* This is the top-level entry point for add_files. It does a couple
341 * of error checks, sets up the progress-printing timer and then calls
342 * into the recursive function. */
343 static notmuch_status_t
344 add_files (notmuch_database_t *notmuch,
346 add_files_state_t *state)
349 notmuch_status_t status;
350 struct sigaction action;
351 struct itimerval timerval;
353 if (stat (path, &st)) {
354 fprintf (stderr, "Error reading directory %s: %s\n",
355 path, strerror (errno));
356 return NOTMUCH_STATUS_FILE_ERROR;
359 if (! S_ISDIR (st.st_mode)) {
360 fprintf (stderr, "Error: %s is not a directory.\n", path);
361 return NOTMUCH_STATUS_FILE_ERROR;
364 /* Setup our handler for SIGALRM */
365 memset (&action, 0, sizeof (struct sigaction));
366 action.sa_handler = handle_sigalrm;
367 sigemptyset (&action.sa_mask);
368 action.sa_flags = SA_RESTART;
369 sigaction (SIGALRM, &action, NULL);
371 /* Then start a timer to send SIGALRM once per second. */
372 timerval.it_interval.tv_sec = 1;
373 timerval.it_interval.tv_usec = 0;
374 timerval.it_value.tv_sec = 1;
375 timerval.it_value.tv_usec = 0;
376 setitimer (ITIMER_REAL, &timerval, NULL);
378 status = add_files_recursive (notmuch, path, &st, state);
380 /* Now stop the timer. */
381 timerval.it_interval.tv_sec = 0;
382 timerval.it_interval.tv_usec = 0;
383 timerval.it_value.tv_sec = 0;
384 timerval.it_value.tv_usec = 0;
385 setitimer (ITIMER_REAL, &timerval, NULL);
387 /* And disable the signal handler. */
388 action.sa_handler = SIG_IGN;
389 sigaction (SIGALRM, &action, NULL);
394 /* Recursively count all regular files in path and all sub-direcotries
395 * of path. The result is added to *count (which should be
396 * initialized to zero by the top-level caller before calling
399 count_files (const char *path, int *count)
402 struct dirent *e, *entry = NULL;
408 dir = opendir (path);
411 fprintf (stderr, "Warning: failed to open directory %s: %s\n",
412 path, strerror (errno));
416 entry_length = offsetof (struct dirent, d_name) +
417 pathconf (path, _PC_NAME_MAX) + 1;
418 entry = malloc (entry_length);
421 err = readdir_r (dir, entry, &e);
423 fprintf (stderr, "Error reading directory: %s\n",
432 /* Ignore special directories to avoid infinite recursion.
433 * Also ignore the .notmuch directory.
435 /* XXX: Eventually we'll want more sophistication to let the
436 * user specify files to be ignored. */
437 if (strcmp (entry->d_name, ".") == 0 ||
438 strcmp (entry->d_name, "..") == 0 ||
439 strcmp (entry->d_name, ".notmuch") == 0)
444 if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
446 fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
447 path, entry->d_name);
453 if (S_ISREG (st.st_mode)) {
455 if (*count % 1000 == 0) {
456 printf ("Found %d files so far.\r", *count);
459 } else if (S_ISDIR (st.st_mode)) {
460 count_files (next, count);
474 setup_command (unused (int argc), unused (char *argv[]))
476 notmuch_database_t *notmuch = NULL;
477 char *default_path, *mail_directory = NULL;
480 add_files_state_t add_files_state;
482 struct timeval tv_now;
483 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
485 printf ("Welcome to notmuch!\n\n");
487 printf ("The goal of notmuch is to help you manage and search your collection of\n"
488 "email, and to efficiently keep up with the flow of email as it comes in.\n\n");
490 printf ("Notmuch needs to know the top-level directory of your email archive,\n"
491 "(where you already have mail stored and where messages will be delivered\n"
492 "in the future). This directory can contain any number of sub-directories\n"
493 "and primarily just files with indvidual email messages (eg. maildir or mh\n"
494 "archives are perfect). If there are other, non-email files (such as\n"
495 "indexes maintained by other email programs) then notmuch will do its\n"
496 "best to detect those and ignore them.\n\n");
498 printf ("Mail storage that uses mbox format, (where one mbox file contains many\n"
499 "messages), will not work with notmuch. If that's how your mail is currently\n"
500 "stored, we recommend you first convert it to maildir format with a utility\n"
501 "such as mb2md. In that case, press Control-C now and run notmuch again\n"
502 "once the conversion is complete.\n\n");
505 default_path = notmuch_database_default_path ();
506 printf ("Top-level mail directory [%s]: ", default_path);
509 getline (&mail_directory, &line_size, stdin);
510 chomp_newline (mail_directory);
514 if (mail_directory == NULL || strlen (mail_directory) == 0) {
516 free (mail_directory);
517 mail_directory = default_path;
519 /* XXX: Instead of telling the user to use an environment
520 * variable here, we should really be writing out a configuration
521 * file and loading that on the next run. */
522 if (strcmp (mail_directory, default_path)) {
523 printf ("Note: Since you are not using the default path, you will want to set\n"
524 "the NOTMUCH_BASE environment variable to %s so that\n"
525 "future calls to notmuch commands will know where to find your mail.\n",
527 printf ("For example, if you are using bash for your shell, add:\n\n");
528 printf ("\texport NOTMUCH_BASE=%s\n\n", mail_directory);
529 printf ("to your ~/.bashrc file.\n\n");
534 notmuch = notmuch_database_create (mail_directory);
535 if (notmuch == NULL) {
536 fprintf (stderr, "Failed to create new notmuch database at %s\n",
538 ret = NOTMUCH_STATUS_FILE_ERROR;
542 printf ("OK. Let's take a look at the mail we can find in the directory\n");
543 printf ("%s ...\n", mail_directory);
546 count_files (mail_directory, &count);
548 printf ("Found %d total files. That's not much mail.\n\n", count);
550 printf ("Next, we'll inspect the messages and create a database of threads:\n");
552 add_files_state.ignore_read_only_directories = FALSE;
553 add_files_state.saw_read_only_directory = FALSE;
554 add_files_state.total_files = count;
555 add_files_state.processed_files = 0;
556 add_files_state.added_messages = 0;
557 add_files_state.callback = NULL;
558 gettimeofday (&add_files_state.tv_start, NULL);
560 ret = add_files (notmuch, mail_directory, &add_files_state);
562 gettimeofday (&tv_now, NULL);
563 elapsed = tv_elapsed (add_files_state.tv_start,
565 printf ("Processed %d %s in ", add_files_state.processed_files,
566 add_files_state.processed_files == 1 ?
567 "file" : "total files");
568 print_formatted_seconds (elapsed);
570 printf (" (%d files/sec.). \n",
571 (int) (add_files_state.processed_files / elapsed));
575 if (add_files_state.added_messages) {
576 printf ("Added %d %s to the database.\n\n",
577 add_files_state.added_messages,
578 add_files_state.added_messages == 1 ?
579 "message" : "unique messages");
582 printf ("When new mail is delivered to %s in the future,\n"
583 "run \"notmuch new\" to add it to the database.\n\n",
587 printf ("Note: At least one error was encountered: %s\n",
588 notmuch_status_to_string (ret));
593 free (mail_directory);
595 notmuch_database_close (notmuch);
601 tag_inbox_and_unread (notmuch_message_t *message)
603 notmuch_message_add_tag (message, "inbox");
604 notmuch_message_add_tag (message, "unread");
608 new_command (unused (int argc), unused (char *argv[]))
610 notmuch_database_t *notmuch;
611 const char *mail_directory;
612 add_files_state_t add_files_state;
614 struct timeval tv_now;
617 notmuch = notmuch_database_open (NULL);
618 if (notmuch == NULL) {
623 mail_directory = notmuch_database_get_path (notmuch);
625 add_files_state.ignore_read_only_directories = TRUE;
626 add_files_state.saw_read_only_directory = FALSE;
627 add_files_state.total_files = 0;
628 add_files_state.processed_files = 0;
629 add_files_state.added_messages = 0;
630 add_files_state.callback = tag_inbox_and_unread;
631 gettimeofday (&add_files_state.tv_start, NULL);
633 ret = add_files (notmuch, mail_directory, &add_files_state);
635 gettimeofday (&tv_now, NULL);
636 elapsed = tv_elapsed (add_files_state.tv_start,
638 if (add_files_state.processed_files) {
639 printf ("Processed %d %s in ", add_files_state.processed_files,
640 add_files_state.processed_files == 1 ?
641 "file" : "total files");
642 print_formatted_seconds (elapsed);
644 printf (" (%d files/sec.). \n",
645 (int) (add_files_state.processed_files / elapsed));
650 if (add_files_state.added_messages) {
651 printf ("Added %d new %s to the database (not much, really).\n",
652 add_files_state.added_messages,
653 add_files_state.added_messages == 1 ?
654 "message" : "messages");
656 printf ("No new mail---and that's not much.\n");
659 if (elapsed > 1 && ! add_files_state.saw_read_only_directory) {
660 printf ("\nTip: If you have any sub-directories that are archives (that is,\n"
661 "they will never receive new mail), marking these directores as\n"
662 "read-only (chmod u-w /path/to/dir) will make \"notmuch new\"\n"
663 "much more efficient (it won't even look in those directories).\n");
667 printf ("\nNote: At least one error was encountered: %s\n",
668 notmuch_status_to_string (ret));
673 notmuch_database_close (notmuch);
678 /* Construct a single query string from the passed arguments, using
679 * 'ctx' as the talloc owner for all allocations.
681 * Currently, the arguments are just connected with space characters,
682 * but we might do more processing in the future, (such as inserting
683 * any AND operators needed to work around Xapian QueryParser bugs).
685 * This function returns NULL in case of insufficient memory.
688 query_string_from_args (void *ctx, int argc, char *argv[])
693 query_string = talloc_strdup (ctx, "");
694 if (query_string == NULL)
697 for (i = 0; i < argc; i++) {
699 query_string = talloc_strdup_append (query_string, " ");
700 if (query_string == NULL)
704 query_string = talloc_strdup_append (query_string, argv[i]);
705 if (query_string == NULL)
713 search_command (int argc, char *argv[])
715 void *local = talloc_new (NULL);
716 notmuch_database_t *notmuch = NULL;
717 notmuch_query_t *query;
718 notmuch_thread_results_t *results;
719 notmuch_thread_t *thread;
720 notmuch_tags_t *tags;
722 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
724 notmuch = notmuch_database_open (NULL);
725 if (notmuch == NULL) {
730 query_str = query_string_from_args (local, argc, argv);
732 query = notmuch_query_create (notmuch, query_str);
734 fprintf (stderr, "Out of memory\n");
739 for (results = notmuch_query_search_threads (query);
740 notmuch_thread_results_has_more (results);
741 notmuch_thread_results_advance (results))
745 thread = notmuch_thread_results_get (results);
748 notmuch_thread_get_thread_id (thread),
749 notmuch_thread_get_subject (thread));
752 for (tags = notmuch_thread_get_tags (thread);
753 notmuch_tags_has_more (tags);
754 notmuch_tags_advance (tags))
758 printf ("%s", notmuch_tags_get (tags));
763 notmuch_thread_destroy (thread);
766 notmuch_query_destroy (query);
770 notmuch_database_close (notmuch);
777 show_command (unused (int argc), unused (char *argv[]))
779 fprintf (stderr, "Error: show is not implemented yet.\n");
784 tag_command (unused (int argc), unused (char *argv[]))
787 int *add_tags, *remove_tags;
788 int add_tags_count = 0;
789 int remove_tags_count = 0;
791 notmuch_database_t *notmuch = NULL;
792 notmuch_query_t *query;
793 notmuch_message_results_t *results;
794 notmuch_message_t *message;
798 local = talloc_new (NULL);
804 add_tags = talloc_size (local, argc * sizeof (int));
805 if (add_tags == NULL) {
810 remove_tags = talloc_size (local, argc * sizeof (int));
811 if (remove_tags == NULL) {
816 for (i = 0; i < argc; i++) {
817 if (strcmp (argv[i], "--") == 0) {
821 if (argv[i][0] == '+') {
822 add_tags[add_tags_count++] = i;
823 } else if (argv[i][0] == '-') {
824 remove_tags[remove_tags_count++] = i;
830 if (add_tags_count == 0 && remove_tags_count == 0) {
831 fprintf (stderr, "Error: 'notmuch tag' requires at least one tag to add or remove.\n");
837 fprintf (stderr, "Error: 'notmuch tag' requires at least one search term.\n");
842 notmuch = notmuch_database_open (NULL);
843 if (notmuch == NULL) {
848 query_string = query_string_from_args (local, argc - i, &argv[i]);
850 query = notmuch_query_create (notmuch, query_string);
852 fprintf (stderr, "Out of memory.\n");
857 for (results = notmuch_query_search_messages (query);
858 notmuch_message_results_has_more (results);
859 notmuch_message_results_advance (results))
861 message = notmuch_message_results_get (results);
863 notmuch_message_freeze (message);
865 for (i = 0; i < remove_tags_count; i++)
866 notmuch_message_remove_tag (message,
867 argv[remove_tags[i]] + 1);
869 for (i = 0; i < add_tags_count; i++)
870 notmuch_message_add_tag (message, argv[add_tags[i]] + 1);
872 notmuch_message_thaw (message);
874 notmuch_message_destroy (message);
877 notmuch_query_destroy (query);
881 notmuch_database_close (notmuch);
889 dump_command (int argc, char *argv[])
892 notmuch_database_t *notmuch = NULL;
893 notmuch_query_t *query;
894 notmuch_message_results_t *results;
895 notmuch_message_t *message;
896 notmuch_tags_t *tags;
900 output = fopen (argv[0], "w");
901 if (output == NULL) {
902 fprintf (stderr, "Error opening %s for writing: %s\n",
903 argv[0], strerror (errno));
911 notmuch = notmuch_database_open (NULL);
912 if (notmuch == NULL) {
917 query = notmuch_query_create (notmuch, "");
919 fprintf (stderr, "Out of memory\n");
924 notmuch_query_set_sort (query, NOTMUCH_SORT_MESSAGE_ID);
926 for (results = notmuch_query_search_messages (query);
927 notmuch_message_results_has_more (results);
928 notmuch_message_results_advance (results))
931 message = notmuch_message_results_get (results);
934 "%s (", notmuch_message_get_message_id (message));
936 for (tags = notmuch_message_get_tags (message);
937 notmuch_tags_has_more (tags);
938 notmuch_tags_advance (tags))
941 fprintf (output, " ");
943 fprintf (output, "%s", notmuch_tags_get (tags));
948 fprintf (output, ")\n");
950 notmuch_message_destroy (message);
953 notmuch_query_destroy (query);
957 notmuch_database_close (notmuch);
958 if (output && output != stdout)
965 restore_command (int argc, char *argv[])
968 notmuch_database_t *notmuch = NULL;
977 input = fopen (argv[0], "r");
979 fprintf (stderr, "Error opening %s for reading: %s\n",
980 argv[0], strerror (errno));
985 printf ("No filename given. Reading dump from stdin.\n");
989 notmuch = notmuch_database_open (NULL);
990 if (notmuch == NULL) {
995 /* Dump output is one line per message. We match a sequence of
996 * non-space characters for the message-id, then one or more
997 * spaces, then a list of space-separated tags as a sequence of
998 * characters within literal '(' and ')'. */
1000 "^([^ ]+) \\(([^)]*)\\)$",
1003 while ((line_len = getline (&line, &line_size, input)) != -1) {
1004 regmatch_t match[3];
1005 char *message_id, *tags, *tag, *next;
1006 notmuch_message_t *message;
1007 notmuch_status_t status;
1009 chomp_newline (line);
1011 rerr = xregexec (®ex, line, 3, match, 0);
1012 if (rerr == REG_NOMATCH)
1014 fprintf (stderr, "Warning: Ignoring invalid input line: %s\n",
1019 message_id = xstrndup (line + match[1].rm_so,
1020 match[1].rm_eo - match[1].rm_so);
1021 tags = xstrndup (line + match[2].rm_so,
1022 match[2].rm_eo - match[2].rm_so);
1024 if (strlen (tags)) {
1026 message = notmuch_database_find_message (notmuch, message_id);
1027 if (message == NULL) {
1028 fprintf (stderr, "Warning: Cannot apply tags to missing message: %s\n",
1033 notmuch_message_freeze (message);
1035 notmuch_message_remove_all_tags (message);
1039 tag = strsep (&next, " ");
1042 status = notmuch_message_add_tag (message, tag);
1045 "Error applying tag %s to message %s:\n",
1047 fprintf (stderr, "%s\n",
1048 notmuch_status_to_string (status));
1052 notmuch_message_thaw (message);
1053 notmuch_message_destroy (message);
1066 notmuch_database_close (notmuch);
1067 if (input && input != stdin)
1074 help_command (int argc, char *argv[]);
1076 command_t commands[] = {
1077 { "setup", setup_command,
1078 "Interactively setup notmuch for first use.",
1079 "\t\tThe setup command is the first command you will run in order\n"
1080 "\t\tto start using notmuch. It will prompt you for the directory\n"
1081 "\t\tcontaining your email archives, and will then proceed to build\n"
1082 "\t\ta database to allow fast searching of that mail.\n\n"
1083 "\t\tInvoking notmuch with no command argument will run setup if\n"
1084 "\t\tthe setup command has not previously been completed." },
1085 { "new", new_command,
1086 "Find and import any new messages.",
1087 "\t\tScans all sub-directories of the database, adding new messages\n"
1088 "\t\tthat are found. Each new message will be tagged as both\n"
1089 "\t\t\"inbox\" and \"unread\".\n"
1091 "\t\tNote: \"notmuch new\" will skip any read-only directories,\n"
1092 "\t\tso you can use that to mark tdirectories that will not\n"
1093 "\t\treceive any new mail (and make \"notmuch new\" faster)." },
1094 { "search", search_command,
1095 "<search-term> [...]\n\n"
1096 "\t\tSearch for threads matching the given search terms.",
1097 "\t\tNote that the individual mail messages will be matched\n"
1098 "\t\tagainst the search terms, but the results will be the\n"
1099 "\t\tthreads containing the matched messages.\n\n"
1100 "\t\tCurrently, the supported search terms are as follows, (where\n"
1101 "\t\t<brackets> indicate user-supplied values):\n\n"
1103 "\t\t\tid:<message-id>\n"
1104 "\t\t\tthread:<thread-id>\n\n"
1105 "\t\tValid tag values include \"inbox\" and \"unread\" by default\n"
1106 "\t\tfor new messages added by \"notmuch new\" as well as any other\n"
1107 "\t\ttag values added manually with \"notmuch tag\".\n\n"
1108 "\t\tMessage ID values are the literal contents of the Message-ID:\n"
1109 "\t\theader of email messages, but without the '<','>' delimiters.\n\n"
1110 "\t\tThread ID values are generated internally by notmuch but can\n"
1111 "\t\tbe seen in the output of \"notmuch search\" for example.\n\n"
1112 "\t\tIn addition to individual terms, multiple terms can be\n"
1113 "\t\tcombined with Boolean operators (\"and\", \"or\", \"not\", etc.).\n"
1114 "\t\tEach term in the query will be implicitly connected by a\n"
1115 "\t\tlogical AND if no explicit operator is provided, (except\n"
1116 "\t\tthat terms with a common prefix will be implicitly combined\n"
1117 "\t\twith OR until we get Xapian defect #402 fixed).\n\n"
1118 "\t\tParentheses can also be used to control the combination of\n"
1119 "\t\tthe Boolean operators, but will have to be protected from\n"
1120 "\t\tinterpretation by the shell, (such as by putting quotation\n"
1121 "\t\tmarks around any parenthesized expression)." },
1122 { "show", show_command,
1124 "\t\tNote: The \"notmuch show\" command is not implemented yet.\n\n"
1125 "\t\tShow the thread with the given thread ID (see 'search').",
1126 "\t\tThread ID values are given as the first column in the\n"
1127 "\t\toutput of the \"notmuch search\" command. These are the\n"
1128 "\t\trandom-looking strings of 32 characters." },
1129 { "tag", tag_command,
1130 "+<tag>|-<tag> [...] [--] <search-term> [...]\n\n"
1131 "\t\tAdd/remove tags for all messages matching the search terms.",
1132 "\t\tThe search terms are handled exactly as in 'search' so one\n"
1133 "\t\tcan use that command first to see what will be modified.\n\n"
1134 "\t\tTags prefixed by '+' are added while those prefixed by '-' are\n"
1135 "\t\tremoved. For each message, tag removal is before tag addition.\n\n"
1136 "\t\tThe beginning of <search-terms> is recognized by the first\n"
1137 "\t\targument that begins with neither '+' nor '-'. Support for\n"
1138 "\t\tan initial search term beginning with '+' or '-' is provided\n"
1139 "\t\tby allowing the user to specify a \"--\" argument to separate\n"
1140 "\t\tthe tags from the search terms.\n\n"
1141 "\t\tNote: If you run \"notmuch new\" between reading a thread with\n"
1142 "\t\t\"notmuch show\" and removing the \"inbox\" tag for that thread\n"
1143 "\t\twith \"notmuch tag\" then you create the possibility of moving\n"
1144 "\t\tsome messages from that thread out of your inbox without ever\n"
1145 "\t\treading them. The easiest way to avoid this problem is to not\n"
1146 "\t\trun \"notmuch new\" between reading and removing tags." },
1147 { "dump", dump_command,
1149 "\t\tCreate a plain-text dump of the tags for each message.",
1150 "\t\tOutput is to the given filename, if any, or to stdout.\n"
1151 "\t\tThese tags are the only data in the notmuch database\n"
1152 "\t\tthat can't be recreated from the messages themselves.\n"
1153 "\t\tThe output of notmuch dump is therefore the only\n"
1154 "\t\tcritical thing to backup (and much more friendly to\n"
1155 "\t\tincremental backup than the native database files.)" },
1156 { "restore", restore_command,
1158 "\t\tRestore the tags from the given dump file (see 'dump').",
1159 "\t\tNote: The dump file format is specifically chosen to be\n"
1160 "\t\tcompatible with the format of files produced by sup-dump.\n"
1161 "\t\tSo if you've previously been using sup for mail, then the\n"
1162 "\t\t\"notmuch restore\" command provides you a way to import\n"
1163 "\t\tall of your tags (or labels as sup calls them)." },
1164 { "help", help_command,
1166 "\t\tThis message, or more detailed help for the named command.",
1167 "\t\tExcept in this case, where there's not much more detailed\n"
1168 "\t\thelp available." }
1177 fprintf (stderr, "Usage: notmuch <command> [args...]\n");
1178 fprintf (stderr, "\n");
1179 fprintf (stderr, "Where <command> and [args...] are as follows:\n");
1180 fprintf (stderr, "\n");
1182 for (i = 0; i < ARRAY_SIZE (commands); i++) {
1183 command = &commands[i];
1185 fprintf (stderr, "\t%s\t%s\n\n", command->name, command->summary);
1188 fprintf (stderr, "Use \"notmuch help <command>\" for more details on each command.\n\n");
1192 help_command (int argc, char *argv[])
1198 fprintf (stderr, "The notmuch mail system.\n\n");
1203 for (i = 0; i < ARRAY_SIZE (commands); i++) {
1204 command = &commands[i];
1206 if (strcmp (argv[0], command->name) == 0) {
1207 fprintf (stderr, "Help for \"notmuch %s\":\n\n", argv[0]);
1208 fprintf (stderr, "\t%s\t%s\n\n%s\n\n", command->name,
1209 command->summary, command->documentation);
1215 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
1221 main (int argc, char *argv[])
1227 return setup_command (0, NULL);
1229 for (i = 0; i < ARRAY_SIZE (commands); i++) {
1230 command = &commands[i];
1232 if (strcmp (argv[1], command->name) == 0)
1233 return (command->function) (argc - 2, &argv[2]);
1236 /* Don't complain about "help" being an unknown command when we're
1237 about to provide exactly what's wanted anyway. */
1238 fprintf (stderr, "Error: Unknown command '%s'\n\n", argv[1]);