X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.c;h=477a09cf05dd1bd803e8d68bfadf0e3c82660a65;hp=73d9a9acf2483e711415ba4330a977d5c9688882;hb=90cd1bac4eeb0d57fbe2740625aaa58d8d925ee5;hpb=36640b303ea68ae28e89f27694356141f515819b diff --git a/notmuch.c b/notmuch.c index 73d9a9ac..477a09cf 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,253 +16,288 @@ * 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 -#include -#include -#include -#include -#include -#include -#include +#include "notmuch-client.h" -#include - -#define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0])) - -typedef int (*command_function_t) (int argc, char *argv[]); +typedef int (*command_function_t) (void *ctx, int argc, char *argv[]); typedef struct command { const char *name; command_function_t function; - const char *usage; + const char *arguments; + 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; +#define MAX_ALIAS_SUBSTITUTIONS 3 - GIOChannel *channel = g_io_channel_unix_new (fileno (stdin)); +typedef struct alias { + const char *name; + const char *substitutions[MAX_ALIAS_SUBSTITUTIONS]; +} alias_t; - g_io_status = g_io_channel_read_line (channel, &result, - &length, NULL, &error); +alias_t aliases[] = { + { "part", { "show", "--format=raw"}}, + { "search-tags", {"search", "--output=tags", "*"}} +}; - if (g_io_status == EOF) - goto DONE; +static int +notmuch_help_command (void *ctx, int argc, char *argv[]); + +static command_t commands[] = { + { "setup", notmuch_setup_command, + NULL, + "Interactively setup notmuch for first use." }, + { "new", notmuch_new_command, + "[options...]", + "Find and import new messages to the notmuch database." }, + { "search", notmuch_search_command, + "[options...] [...]", + "Search for messages matching the given search terms." }, + { "show", notmuch_show_command, + " [...]", + "Show all messages matching the search terms." }, + { "count", notmuch_count_command, + "[options...] [...]", + "Count messages matching the search terms." }, + { "reply", notmuch_reply_command, + "[options...] [...]", + "Construct a reply template for a set of messages." }, + { "tag", notmuch_tag_command, + "+|- [...] [--] [...]" , + "Add/remove tags for all messages matching the search terms." }, + { "dump", notmuch_dump_command, + "[] [--] []", + "Create a plain-text dump of the tags for each message." }, + { "restore", notmuch_restore_command, + "[--accumulate] []", + "Restore the tags from the given dump file (see 'dump')." }, + { "config", notmuch_config_command, + "[get|set]
. [value ...]", + "Get or set settings in the notmuch configuration file." }, + { "help", notmuch_help_command, + "[]", + "This message, or more detailed help for the named command." } +}; - if (g_io_status != G_IO_STATUS_NORMAL) { - fprintf(stderr, "Read error: %s\n", error->message); - exit (1); - } +static void +usage (FILE *out) +{ + command_t *command; + unsigned int i; - if (length && result[length - 1] == '\n') - result[length - 1] = '\0'; + 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"); - DONE: - g_io_channel_unref (channel); - return result; -} + for (i = 0; i < ARRAY_SIZE (commands); i++) { + command = &commands[i]; -/* 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) -{ - DIR *dir; - struct dirent *entry, *e; - int entry_length; - int err; - char *next; - struct stat st; + fprintf (out, " %-11s %s\n", + command->name, command->summary); + } - dir = opendir (path); + fprintf (out, "\n"); + fprintf (out, + "Use \"notmuch help \" for more details on each command\n" + "and \"notmuch help search-terms\" for the common search-terms syntax.\n\n"); +} - if (dir == NULL) { - fprintf (stderr, "Warning: failed to open directory %s: %s\n", - path, strerror (errno)); - return; +static void +exec_man (const char *page) +{ + 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; - } - - if (e == NULL) - break; +static int +notmuch_help_command (void *ctx, int argc, char *argv[]) +{ + command_t *command; + unsigned int i; - /* Skip these special directories to avoid infinite recursion. */ - if (strcmp (entry->d_name, ".") == 0 || - strcmp (entry->d_name, "..") == 0) - { - continue; - } + argc--; argv++; /* Ignore "help" */ - next = g_strdup_printf ("%s/%s", path, entry->d_name); + if (argc == 0) { + printf ("The notmuch mail system.\n\n"); + usage (stdout); + return 0; + } - stat (next, &st); + 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 0; + } - if (S_ISREG (st.st_mode)) - *count = *count + 1; - else if (S_ISDIR (st.st_mode)) - count_files (next, count); + for (i = 0; i < ARRAY_SIZE (commands); i++) { + command = &commands[i]; - if (*count % 1000 == 0) { - printf ("Found %d files so far.\r", *count); - fflush (stdout); + if (strcmp (argv[0], command->name) == 0) { + char *page = talloc_asprintf (ctx, "notmuch-%s", command->name); + exec_man (page); } - - free (next); } - free (entry); + if (strcmp (argv[0], "search-terms") == 0) { + exec_man ("notmuch-search-terms"); + } else if (strcmp (argv[0], "hooks") == 0) { + exec_man ("notmuch-hooks"); + } - 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 1; } -int -setup_command (int argc, char *argv[]) +/* 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 (void *ctx) { - char *mail_directory; - int count; - - 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 (); + notmuch_config_t *config; + notmuch_bool_t is_new; + char *db_path; + struct stat st; - if (mail_directory == NULL || strlen (mail_directory) == 0) { - char *home; + config = notmuch_config_open (ctx, NULL, &is_new); - if (mail_directory) - free (mail_directory); + /* 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 (is_new) { + notmuch_config_close (config); + return notmuch_setup_command (ctx, 0, NULL); + } - 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); + /* Notmuch is already configured, but is there a database? */ + db_path = talloc_asprintf (ctx, "%s/%s", + notmuch_config_get_database_path (config), + ".notmuch"); + if (stat (db_path, &st)) { + notmuch_config_close (config); + if (errno != ENOENT) { + fprintf (stderr, "Error looking for notmuch database at %s: %s\n", + db_path, strerror (errno)); + return 1; } - - mail_directory = g_strdup_printf ("%s/mail", home); + 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 0; } - 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", count); + 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)); + + notmuch_config_close (config); - free (mail_directory); - return 0; } int -search_command (int argc, char *argv[]) +main (int argc, char *argv[]) { - fprintf (stderr, "Error: search is not implemented yet.\n"); - return 1; -} + void *local; + command_t *command; + alias_t *alias; + unsigned int i, j; + const char **argv_local; -int -show_command (int argc, char *argv[]) -{ - fprintf (stderr, "Error: show-thread is not implemented yet.\n"); - return 1; -} + talloc_enable_null_tracking (); -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')." } -}; + local = talloc_new (NULL); -void -usage (void) -{ - command_t *command; - int i; + g_mime_init (0); + g_type_init (); - fprintf (stderr, "Usage: notmuch [args...]\n"); - fprintf (stderr, "\n"); - fprintf (stderr, "Where is one of the following:\n"); - fprintf (stderr, "\n"); + if (argc == 1) + return notmuch (local); - for (i = 0; i < ARRAY_SIZE (commands); i++) { - command = &commands[i]; + if (STRNCMP_LITERAL (argv[1], "--help") == 0) + return notmuch_help_command (NULL, argc - 1, &argv[1]); - fprintf (stderr, "\t%s\t%s\n\n", command->name, command->usage); + if (STRNCMP_LITERAL (argv[1], "--version") == 0) { + printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n"); + return 0; } -} - -int -main (int argc, char *argv[]) -{ - command_t *command; - int i; - if (argc == 1) - return setup_command (0, NULL); + for (i = 0; i < ARRAY_SIZE (aliases); i++) { + alias = &aliases[i]; + + if (strcmp (argv[1], alias->name) == 0) + { + int substitutions; + + argv_local = talloc_size (local, sizeof (char *) * + (argc + MAX_ALIAS_SUBSTITUTIONS - 1)); + if (argv_local == NULL) { + fprintf (stderr, "Out of memory.\n"); + return 1; + } + + /* Copy all substution arguments from the alias. */ + argv_local[0] = argv[0]; + for (j = 0; j < MAX_ALIAS_SUBSTITUTIONS; j++) { + if (alias->substitutions[j] == NULL) + break; + argv_local[j+1] = alias->substitutions[j]; + } + substitutions = j; + + /* And copy all original arguments (skipping the argument + * that matched the alias of course. */ + for (j = 2; j < (unsigned) argc; j++) { + argv_local[substitutions+j-1] = argv[j]; + } + + argc += substitutions - 1; + argv = (char **) argv_local; + } + } for (i = 0; i < ARRAY_SIZE (commands); i++) { command = &commands[i]; if (strcmp (argv[1], command->name) == 0) - return (command->function) (argc - 2, &argv[2]); + return (command->function) (local, argc - 1, &argv[1]); } - fprintf (stderr, "Error: Unknown command '%s'\n\n", argv[1]); - usage (); - exit (1); + fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n", + argv[1]); - return 0; + talloc_free (local); + + return 1; }