X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.c;h=dcda0392a0945123f735399f72308c8653a3b1f4;hp=91ea34513f6076616fbd6557504d2ab109f1f714;hb=c878081127f48c393835b6f067f8f85beda9ff29;hpb=22691064666c03c5e76bc787395bfe586929f4cc diff --git a/notmuch.c b/notmuch.c index 91ea3451..dcda0392 100644 --- a/notmuch.c +++ b/notmuch.c @@ -1,6 +1,7 @@ /* notmuch - Not much of an email program, (just index and search) * * Copyright © 2009 Carl Worth + * Copyright © 2009 Keith Packard * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -15,415 +16,353 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see http://www.gnu.org/licenses/ . * - * Author: Carl Worth + * Authors: Carl Worth + * Keith Packard */ -#include "notmuch.h" +#include "notmuch-client.h" -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include /* GIOChannel */ - -#define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0])) - -typedef int (*command_function_t) (int argc, char *argv[]); +/* + * Notmuch subcommand hook. + * + * The return value will be used as notmuch exit status code, + * preferrably EXIT_SUCCESS or EXIT_FAILURE. + */ +typedef int (*command_function_t) (notmuch_config_t *config, int argc, char *argv[]); typedef struct command { const char *name; command_function_t function; - const char *usage; + notmuch_bool_t create_config; + const char *summary; } command_t; -/* Read a line from stdin, without any line-terminator character. The - * return value is a newly allocated string. The caller should free() - * the string when finished with it. - * - * This function returns NULL if EOF is encountered before any - * characters are input (otherwise it returns those characters). - */ -char * -read_line (void) -{ - char *result = NULL; - GError *error = NULL; - GIOStatus g_io_status; - gsize length; - - GIOChannel *channel = g_io_channel_unix_new (fileno (stdin)); - - g_io_status = g_io_channel_read_line (channel, &result, - &length, NULL, &error); +static int +notmuch_help_command (notmuch_config_t *config, int argc, char *argv[]); + +static int +notmuch_command (notmuch_config_t *config, int argc, char *argv[]); + +static command_t commands[] = { + { NULL, notmuch_command, TRUE, + "Notmuch main command." }, + { "setup", notmuch_setup_command, TRUE, + "Interactively setup notmuch for first use." }, + { "new", notmuch_new_command, FALSE, + "Find and import new messages to the notmuch database." }, + { "insert", notmuch_insert_command, FALSE, + "Add a new message into the maildir and notmuch database." }, + { "search", notmuch_search_command, FALSE, + "Search for messages matching the given search terms." }, + { "show", notmuch_show_command, FALSE, + "Show all messages matching the search terms." }, + { "count", notmuch_count_command, FALSE, + "Count messages matching the search terms." }, + { "reply", notmuch_reply_command, FALSE, + "Construct a reply template for a set of messages." }, + { "tag", notmuch_tag_command, FALSE, + "Add/remove tags for all messages matching the search terms." }, + { "dump", notmuch_dump_command, FALSE, + "Create a plain-text dump of the tags for each message." }, + { "restore", notmuch_restore_command, FALSE, + "Restore the tags from the given dump file (see 'dump')." }, + { "compact", notmuch_compact_command, FALSE, + "Compact the notmuch database." }, + { "config", notmuch_config_command, FALSE, + "Get or set settings in the notmuch configuration file." }, + { "help", notmuch_help_command, TRUE, /* create but don't save config */ + "This message, or more detailed help for the named command." } +}; - if (g_io_status == EOF) - goto DONE; +typedef struct help_topic { + const char *name; + const char *summary; +} help_topic_t; + +static help_topic_t help_topics[] = { + { "search-terms", + "Common search term syntax." }, + { "hooks", + "Hooks that will be run before or after certain commands." }, +}; - if (g_io_status != G_IO_STATUS_NORMAL) { - fprintf(stderr, "Read error: %s\n", error->message); - exit (1); - } +static command_t * +find_command (const char *name) +{ + size_t i; - if (length && result[length - 1] == '\n') - result[length - 1] = '\0'; + for (i = 0; i < ARRAY_SIZE (commands); i++) + if ((!name && !commands[i].name) || + (name && commands[i].name && strcmp (name, commands[i].name) == 0)) + return &commands[i]; - DONE: - g_io_channel_unref (channel); - return result; + return NULL; } -typedef struct { - int total_messages; - int count; - struct timeval tv_start; -} add_files_state_t; +int notmuch_format_version; -/* Compute the number of seconds elapsed from start to end. */ -double -tv_elapsed (struct timeval start, struct timeval end) +static void +usage (FILE *out) { - return ((end.tv_sec - start.tv_sec) + - (end.tv_usec - start.tv_usec) / 1e6); -} + command_t *command; + help_topic_t *topic; + unsigned int i; -void -print_formatted_seconds (double seconds) -{ - int hours; - int minutes; + fprintf (out, + "Usage: notmuch --help\n" + " notmuch --version\n" + " notmuch [args...]\n"); + fprintf (out, "\n"); + fprintf (out, "The available commands are as follows:\n"); + fprintf (out, "\n"); + + for (i = 0; i < ARRAY_SIZE (commands); i++) { + command = &commands[i]; - if (seconds > 3600) { - hours = (int) seconds / 3600; - printf ("%dh ", hours); - seconds -= hours * 3600; + if (command->name) + fprintf (out, " %-12s %s\n", command->name, command->summary); } - if (seconds > 60) { - minutes = (int) seconds / 60; - printf ("%dm ", minutes); - seconds -= minutes * 60; + fprintf (out, "\n"); + fprintf (out, "Additional help topics are as follows:\n"); + fprintf (out, "\n"); + + for (i = 0; i < ARRAY_SIZE (help_topics); i++) { + topic = &help_topics[i]; + fprintf (out, " %-12s %s\n", topic->name, topic->summary); } - printf ("%02ds", (int) seconds); + fprintf (out, "\n"); + fprintf (out, + "Use \"notmuch help \" for more details " + "on each command or topic.\n\n"); } void -add_files_print_progress (add_files_state_t *state) +notmuch_exit_if_unsupported_format (void) { - struct timeval tv_now; - double elapsed_overall, rate_overall; - - gettimeofday (&tv_now, NULL); - - elapsed_overall = tv_elapsed (state->tv_start, tv_now); - rate_overall = (state->count) / elapsed_overall; - - printf ("Added %d of %d messages (", - state->count, state->total_messages); - print_formatted_seconds ((state->total_messages - state->count) / - rate_overall); - printf (" remaining).\r"); - - fflush (stdout); + if (notmuch_format_version > NOTMUCH_FORMAT_CUR) { + fprintf (stderr, "\ +A caller requested output format version %d, but the installed notmuch\n\ +CLI only supports up to format version %d. You may need to upgrade your\n\ +notmuch CLI.\n", + notmuch_format_version, NOTMUCH_FORMAT_CUR); + exit (NOTMUCH_EXIT_FORMAT_TOO_NEW); + } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) { + fprintf (stderr, "\ +A caller requested output format version %d, which is no longer supported\n\ +by the notmuch CLI (it requires at least version %d). You may need to\n\ +upgrade your notmuch front-end.\n", + notmuch_format_version, NOTMUCH_FORMAT_MIN); + exit (NOTMUCH_EXIT_FORMAT_TOO_OLD); + } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) { + /* Warn about old version requests so compatibility issues are + * less likely when we drop support for a deprecated format + * versions. */ + fprintf (stderr, "\ +A caller requested deprecated output format version %d, which may not\n\ +be supported in the future.\n", notmuch_format_version); + } } -/* Recursively find all regular files in 'path' and add them to the - * database. */ -void -add_files (notmuch_database_t *notmuch, const char *path, - add_files_state_t *state) +static void +exec_man (const char *page) { - DIR *dir; - struct dirent *entry, *e; - int entry_length; - int err; - char *next; - struct stat st; - - dir = opendir (path); - - if (dir == NULL) { - fprintf (stderr, "Warning: failed to open directory %s: %s\n", - path, strerror (errno)); - return; + if (execlp ("man", "man", page, (char *) NULL)) { + perror ("exec man"); + exit (1); } +} - entry_length = offsetof (struct dirent, d_name) + - pathconf (path, _PC_NAME_MAX) + 1; - entry = malloc (entry_length); - - while (1) { - err = readdir_r (dir, entry, &e); - if (err) { - fprintf (stderr, "Error reading directory: %s\n", - strerror (errno)); - free (entry); - return; - } +static int +notmuch_help_command (notmuch_config_t *config, int argc, char *argv[]) +{ + command_t *command; + help_topic_t *topic; + unsigned int i; - if (e == NULL) - break; + argc--; argv++; /* Ignore "help" */ - /* Ignore special directories to avoid infinite recursion. - * Also ignore the .notmuch directory. - */ - /* XXX: Eventually we'll want more sophistication to let the - * user specify files to be ignored. */ - if (strcmp (entry->d_name, ".") == 0 || - strcmp (entry->d_name, "..") == 0 || - strcmp (entry->d_name, ".notmuch") ==0) - { - continue; - } + if (argc == 0) { + printf ("The notmuch mail system.\n\n"); + usage (stdout); + return EXIT_SUCCESS; + } - next = g_strdup_printf ("%s/%s", path, entry->d_name); + if (strcmp (argv[0], "help") == 0) { + printf ("The notmuch help system.\n\n" + "\tNotmuch uses the man command to display help. In case\n" + "\tof difficulties check that MANPATH includes the pages\n" + "\tinstalled by notmuch.\n\n" + "\tTry \"notmuch help\" for a list of topics.\n"); + return EXIT_SUCCESS; + } - stat (next, &st); + command = find_command (argv[0]); + if (command) { + char *page = talloc_asprintf (config, "notmuch-%s", command->name); + exec_man (page); + } - if (S_ISREG (st.st_mode)) { - notmuch_database_add_message (notmuch, next); - state->count++; - if (state->count % 1000 == 0) - add_files_print_progress (state); - } else if (S_ISDIR (st.st_mode)) { - add_files (notmuch, next, state); + for (i = 0; i < ARRAY_SIZE (help_topics); i++) { + topic = &help_topics[i]; + if (strcmp (argv[0], topic->name) == 0) { + char *page = talloc_asprintf (config, "notmuch-%s", topic->name); + exec_man (page); } - - free (next); } - free (entry); - - closedir (dir); + fprintf (stderr, + "\nSorry, %s is not a known command. There's not much I can do to help.\n\n", + argv[0]); + return EXIT_FAILURE; } -/* Recursively count all regular files in path and all sub-direcotries - * of path. The result is added to *count (which should be - * initialized to zero by the top-level caller before calling - * count_files). */ -void -count_files (const char *path, int *count) +/* Handle the case of "notmuch" being invoked with no command + * argument. For now we just call notmuch_setup_command, but we plan + * to be more clever about this in the future. + */ +static int +notmuch_command (notmuch_config_t *config, + unused(int argc), unused(char *argv[])) { - DIR *dir; - struct dirent *entry, *e; - int entry_length; - int err; - char *next; + char *db_path; struct stat st; - dir = opendir (path); - - if (dir == NULL) { - fprintf (stderr, "Warning: failed to open directory %s: %s\n", - path, strerror (errno)); - return; - } - - entry_length = offsetof (struct dirent, d_name) + - pathconf (path, _PC_NAME_MAX) + 1; - entry = malloc (entry_length); - - while (1) { - err = readdir_r (dir, entry, &e); - if (err) { - fprintf (stderr, "Error reading directory: %s\n", - strerror (errno)); - free (entry); - return; + /* If the user has never configured notmuch, then run + * notmuch_setup_command which will give a nice welcome message, + * and interactively guide the user through the configuration. */ + if (notmuch_config_is_new (config)) + return notmuch_setup_command (config, 0, NULL); + + /* Notmuch is already configured, but is there a database? */ + db_path = talloc_asprintf (config, "%s/%s", + notmuch_config_get_database_path (config), + ".notmuch"); + if (stat (db_path, &st)) { + if (errno != ENOENT) { + fprintf (stderr, "Error looking for notmuch database at %s: %s\n", + db_path, strerror (errno)); + return EXIT_FAILURE; } - - if (e == NULL) - break; - - /* Ignore special directories to avoid infinite recursion. - * Also ignore the .notmuch directory. - */ - /* XXX: Eventually we'll want more sophistication to let the - * user specify files to be ignored. */ - if (strcmp (entry->d_name, ".") == 0 || - strcmp (entry->d_name, "..") == 0 || - strcmp (entry->d_name, ".notmuch") == 0) - { - continue; - } - - next = g_strdup_printf ("%s/%s", path, entry->d_name); - - stat (next, &st); - - if (S_ISREG (st.st_mode)) { - *count = *count + 1; - if (*count % 1000 == 0) { - printf ("Found %d files so far.\r", *count); - fflush (stdout); - } - } else if (S_ISDIR (st.st_mode)) { - count_files (next, count); - } - - free (next); + printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n", + db_path); + printf ("You probably want to run \"notmuch new\" now to create that database.\n\n" + "Note that the first run of \"notmuch new\" can take a very long time\n" + "and that the resulting database will use roughly the same amount of\n" + "storage space as the email being indexed.\n\n"); + return EXIT_SUCCESS; } - free (entry); - - closedir (dir); + printf ("Notmuch is configured and appears to have a database. Excellent!\n\n" + "At this point you can start exploring the functionality of notmuch by\n" + "using commands such as:\n\n" + "\tnotmuch search tag:inbox\n\n" + "\tnotmuch search to:\"%s\"\n\n" + "\tnotmuch search from:\"%s\"\n\n" + "\tnotmuch search subject:\"my favorite things\"\n\n" + "See \"notmuch help search\" for more details.\n\n" + "You can also use \"notmuch show\" with any of the thread IDs resulting\n" + "from a search. Finally, you may want to explore using a more sophisticated\n" + "interface to notmuch such as the emacs interface implemented in notmuch.el\n" + "or any other interface described at http://notmuchmail.org\n\n" + "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n" + "Have fun, and may your inbox never have much mail.\n\n", + notmuch_config_get_user_name (config), + notmuch_config_get_user_primary_email (config)); + + return EXIT_SUCCESS; } int -setup_command (int argc, char *argv[]) +main (int argc, char *argv[]) { - notmuch_database_t *notmuch; - char *mail_directory; - int count; - add_files_state_t add_files_state; - double elapsed; - struct timeval tv_now; - - printf ("Welcome to notmuch!\n\n"); - - printf ("The goal of notmuch is to help you manage and search your collection of\n" - "email, and to efficiently keep up with the flow of email as it comes in.\n\n"); - - printf ("Notmuch needs to know the top-level directory of your email archive,\n" - "(where you already have mail stored and where messages will be delivered\n" - "in the future). This directory can contain any number of sub-directories\n" - "but the only files it contains should be individual email messages.\n" - "Either maildir or mh format directories are fine, but you will want to\n" - "move away any auxiliary files maintained by other email programs.\n\n"); - - printf ("Mail storage that uses mbox format, (where one mbox file contains many\n" - "messages), will not work with notmuch. If that's how your mail is currently\n" - "stored, we recommend you first convert it to maildir format with a utility\n" - "such as mb2md. In that case, press Control-C now and run notmuch again\n" - "once the conversion is complete.\n\n"); - - printf ("Top-level mail directory [~/mail]: "); - fflush (stdout); - - mail_directory = read_line (); - - if (mail_directory == NULL || strlen (mail_directory) == 0) { - char *home; - - if (mail_directory) - free (mail_directory); - - home = getenv ("HOME"); - if (!home) { - fprintf (stderr, "Error: No mail directory provided HOME environment variable is not set.\n"); - fprintf (stderr, "Cowardly refusing to just guess where your mail might be.\n"); - exit (1); - } - - mail_directory = g_strdup_printf ("%s/mail", home); + void *local; + char *talloc_report; + const char *command_name = NULL; + command_t *command; + char *config_file_name = NULL; + notmuch_config_t *config = NULL; + notmuch_bool_t print_help=FALSE, print_version=FALSE; + int opt_index; + int ret; + + notmuch_opt_desc_t options[] = { + { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 }, + { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 }, + { NOTMUCH_OPT_STRING, &config_file_name, "config", 'c', 0 }, + { 0, 0, 0, 0, 0 } + }; + + talloc_enable_null_tracking (); + + local = talloc_new (NULL); + + g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS); +#if !GLIB_CHECK_VERSION(2, 35, 1) + g_type_init (); +#endif + + /* Globally default to the current output format version. */ + notmuch_format_version = NOTMUCH_FORMAT_CUR; + + opt_index = parse_arguments (argc, argv, options, 1); + if (opt_index < 0) { + ret = EXIT_FAILURE; + goto DONE; } - notmuch = notmuch_database_create (mail_directory); - if (notmuch == NULL) { - fprintf (stderr, "Failed to create new notmuch database at %s\n", - mail_directory); - free (mail_directory); - return 1; + if (print_help) { + ret = notmuch_help_command (NULL, argc - 1, &argv[1]); + goto DONE; } - printf ("OK. Let's take a look at the mail we can find in the directory\n"); - printf ("%s ...\n", mail_directory); - - count = 0; - count_files (mail_directory, &count); - - printf ("Found %d total files. That's not much mail.\n\n", count); - - printf ("Next, we'll inspect the messages and create a database of threads:\n"); - - add_files_state.total_messages = count; - add_files_state.count = 0; - gettimeofday (&add_files_state.tv_start, NULL); - - add_files (notmuch, mail_directory, &add_files_state); - - gettimeofday (&tv_now, NULL); - elapsed = tv_elapsed (add_files_state.tv_start, - tv_now); - printf ("Added %d total messages in ", add_files_state.count); - print_formatted_seconds (elapsed); - printf (" (%d messages/sec.). \n", (int) (add_files_state.count / elapsed)); - - notmuch_database_close (notmuch); - - free (mail_directory); - - return 0; -} - -int -search_command (int argc, char *argv[]) -{ - fprintf (stderr, "Error: search is not implemented yet.\n"); - return 1; -} - -int -show_command (int argc, char *argv[]) -{ - fprintf (stderr, "Error: show-thread is not implemented yet.\n"); - return 1; -} - -command_t commands[] = { - { "setup", setup_command, - "Interactively setup notmuch for first use (no arguments).\n" - "\t\tInvoking notmuch with no command argument will run setup if\n" - "\t\the setup command has not previously been completed." }, - { "search", search_command, - "Search for threads matching the given search terms." }, - { "show", show_command, - "Show the thread with the given thread ID (see 'search')." } -}; - -void -usage (void) -{ - command_t *command; - int i; + if (print_version) { + printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n"); + ret = EXIT_SUCCESS; + goto DONE; + } - fprintf (stderr, "Usage: notmuch [args...]\n"); - fprintf (stderr, "\n"); - fprintf (stderr, "Where is one of the following:\n"); - fprintf (stderr, "\n"); + if (opt_index < argc) + command_name = argv[opt_index]; - for (i = 0; i < ARRAY_SIZE (commands); i++) { - command = &commands[i]; + command = find_command (command_name); + if (!command) { + fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n", + command_name); + ret = EXIT_FAILURE; + goto DONE; + } - fprintf (stderr, "\t%s\t%s\n\n", command->name, command->usage); + config = notmuch_config_open (local, config_file_name, command->create_config); + if (!config) { + ret = EXIT_FAILURE; + goto DONE; } -} - -int -main (int argc, char *argv[]) -{ - command_t *command; - int i; - if (argc == 1) - return setup_command (0, NULL); + ret = (command->function)(config, argc - opt_index, argv + opt_index); - for (i = 0; i < ARRAY_SIZE (commands); i++) { - command = &commands[i]; + DONE: + if (config) + notmuch_config_close (config); - if (strcmp (argv[1], command->name) == 0) - return (command->function) (argc - 2, &argv[2]); + talloc_report = getenv ("NOTMUCH_TALLOC_REPORT"); + if (talloc_report && strcmp (talloc_report, "") != 0) { + /* this relies on the previous call to + * talloc_enable_null_tracking + */ + + FILE *report = fopen (talloc_report, "w"); + if (report) { + talloc_report_full (NULL, report); + } else { + ret = 1; + fprintf (stderr, "ERROR: unable to write talloc log. "); + perror (talloc_report); + } } - fprintf (stderr, "Error: Unknown command '%s'\n\n", argv[1]); - usage (); - exit (1); + talloc_free (local); - return 0; + return ret; }