#include "notmuch-client.h"
+/*
+ * 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;
+ notmuch_bool_t create_config;
+ const char *summary;
+} command_t;
+
static int
-notmuch_help_command (void *ctx, int argc, char *argv[]);
-
-command_t commands[] = {
- { "setup", notmuch_setup_command,
- "Interactively setup notmuch for first use.",
- "\t\tThe setup command is the first command you will run in order\n"
- "\t\tto start using notmuch. It will prompt you for the directory\n"
- "\t\tcontaining your email archives, and will then proceed to build\n"
- "\t\ta database to allow fast searching of that mail.\n\n"
- "\t\tInvoking notmuch with no command argument will run setup if\n"
- "\t\tthe setup command has not previously been completed." },
- { "new", notmuch_new_command,
- "Find and import any new messages.",
- "\t\tScans all sub-directories of the database, adding new messages\n"
- "\t\tthat are found. Each new message will be tagged as both\n"
- "\t\t\"inbox\" and \"unread\".\n"
- "\n"
- "\t\tNote: \"notmuch new\" will skip any read-only directories,\n"
- "\t\tso you can use that to mark directories that will not\n"
- "\t\treceive any new mail (and make \"notmuch new\" faster)." },
- { "search", notmuch_search_command,
- "<search-term> [...]\n\n"
- "\t\tSearch for threads matching the given search terms.",
- "\t\tNote that the individual mail messages will be matched\n"
- "\t\tagainst the search terms, but the results will be the\n"
- "\t\tthreads containing the matched messages.\n\n"
- "\t\tCurrently, in addition to free text (and quoted phrases)\n"
- "\t\twhich match terms appearing anywhere within an email,\n"
- "\t\tthe following prefixes can be used to search specific\n"
- "\t\tportions of an email, (where <brackets> indicate user-\n"
- "\t\tsupplied values):\n\n"
- "\t\t\tfrom:<name-or-address>\n"
- "\t\t\tto:<name-or-address>\n"
- "\t\t\tsubject:<word-or-quoted-phrase>\n"
- "\t\t\ttag:<tag>\n"
- "\t\t\tid:<message-id>\n"
- "\t\t\tthread:<thread-id>\n\n"
- "\t\tThe from: prefix is used to match the name or address of\n"
- "\t\tthe sender of an email message.\n\n"
- "\t\tThe to: prefix is used to match the names or addresses of\n"
- "\t\tany recipient of an email message, (whether To, Cc, or Bcc).\n\n"
- "\t\tAny term prefixed with subject: will match only text from\n"
- "\t\tthe subject of an email. Quoted phrases are supported when\n"
- "\t\tsearching with: subject:\"this is a phrase\".\n\n"
- "\t\tValid tag values include \"inbox\" and \"unread\" by default\n"
- "\t\tfor new messages added by \"notmuch new\" as well as any other\n"
- "\t\ttag values added manually with \"notmuch tag\".\n\n"
- "\t\tMessage ID values are the literal contents of the Message-ID:\n"
- "\t\theader of email messages, but without the '<','>' delimiters.\n\n"
- "\t\tThread ID values are generated internally by notmuch but can\n"
- "\t\tbe seen in the output of \"notmuch search\" for example.\n\n"
- "\t\tIn addition to individual terms, multiple terms can be\n"
- "\t\tcombined with Boolean operators (\"and\", \"or\", \"not\", etc.).\n"
- "\t\tEach term in the query will be implicitly connected by a\n"
- "\t\tlogical AND if no explicit operator is provided, (except\n"
- "\t\tthat terms with a common prefix will be implicitly combined\n"
- "\t\twith OR until we get Xapian defect #402 fixed).\n\n"
- "\t\tParentheses can also be used to control the combination of\n"
- "\t\tthe Boolean operators, but will have to be protected from\n"
- "\t\tinterpretation by the shell, (such as by putting quotation\n"
- "\t\tmarks around any parenthesized expression)." },
- { "reply", notmuch_reply_command,
- "<search-terms> [...]\n\n"
- "\t\tFormats a reply from a set of existing messages.",
- "\t\tConstructs a new message as a reply to a set of existing\n"
- "\t\tmessages. The From: address is used as a To: address\n"
- "\t\talong with all old To: addresses. All of the Cc: addresses\n"
- "\t\tare copied as new Cc: addresses. An In-Reply-To: header\n"
- "\t\twill be constructed from the name and date of the original\n"
- "\t\tmessage, and the original Message-ID will be added to the\n"
- "\t\tlist of References in the new message. The text of each\n"
- "\t\tmessage (as described in the \"show\" command) will be\n"
- "\t\tpresented, each line prefixed with \"> \" The resulting\n"
- "\t\tmessage will be dumped to stdout." },
- { "show", notmuch_show_command,
- "<search-terms> [...]\n\n"
- "\t\tShows all messages matching the search terms.",
- "\t\tSee the documentation of \"notmuch search\" for details\n"
- "\t\tof the supported syntax of search terms.\n\n"
- "\t\tA common use of \"notmuch show\" is to display a single\n"
- "\t\tthread of email messages. For this, use a search term of\n"
- "\t\t\"thread:<thread-id>\" as can be seen in the first column\n"
- "\t\tof output from the \"notmuch search\" command.\n\n"
- "\t\tAll messages will be displayed in date order. The output\n"
- "\t\tformat is plain-text, with all text-content MIME parts\n"
- "\t\tdecoded. Various components in the output, ('message',\n"
- "\t\t'header', 'body', 'attachment', and MIME 'part') will be\n"
- "\t\tdelimited by easily-parsed markers. Each marker consists\n"
- "\t\tof a Control-L character (ASCII decimal 12), the name of\n"
- "\t\tthe marker, and then either an opening or closing brace,\n"
- "\t\t'{' or '}' to either open or close the component."},
- { "tag", notmuch_tag_command,
- "+<tag>|-<tag> [...] [--] <search-term> [...]\n\n"
- "\t\tAdd/remove tags for all messages matching the search terms.",
- "\t\tThe search terms are handled exactly as in 'search' so one\n"
- "\t\tcan use that command first to see what will be modified.\n\n"
- "\t\tTags prefixed by '+' are added while those prefixed by '-' are\n"
- "\t\tremoved. For each message, tag removal is before tag addition.\n\n"
- "\t\tThe beginning of <search-terms> is recognized by the first\n"
- "\t\targument that begins with neither '+' nor '-'. Support for\n"
- "\t\tan initial search term beginning with '+' or '-' is provided\n"
- "\t\tby allowing the user to specify a \"--\" argument to separate\n"
- "\t\tthe tags from the search terms.\n\n"
- "\t\tNote: If you run \"notmuch new\" between reading a thread with\n"
- "\t\t\"notmuch show\" and removing the \"inbox\" tag for that thread\n"
- "\t\twith \"notmuch tag\" then you create the possibility of moving\n"
- "\t\tsome messages from that thread out of your inbox without ever\n"
- "\t\treading them. The easiest way to avoid this problem is to not\n"
- "\t\trun \"notmuch new\" between reading and removing tags." },
- { "dump", notmuch_dump_command,
- "[<filename>]\n\n"
- "\t\tCreate a plain-text dump of the tags for each message.",
- "\t\tOutput is to the given filename, if any, or to stdout.\n"
- "\t\tThese tags are the only data in the notmuch database\n"
- "\t\tthat can't be recreated from the messages themselves.\n"
- "\t\tThe output of notmuch dump is therefore the only\n"
- "\t\tcritical thing to backup (and much more friendly to\n"
- "\t\tincremental backup than the native database files.)" },
- { "restore", notmuch_restore_command,
- "<filename>\n\n"
- "\t\tRestore the tags from the given dump file (see 'dump').",
- "\t\tNote: The dump file format is specifically chosen to be\n"
- "\t\tcompatible with the format of files produced by sup-dump.\n"
- "\t\tSo if you've previously been using sup for mail, then the\n"
- "\t\t\"notmuch restore\" command provides you a way to import\n"
- "\t\tall of your tags (or labels as sup calls them)." },
- { "help", notmuch_help_command,
- "[<command>]\n\n"
- "\t\tThis message, or more detailed help for the named command.",
- "\t\tExcept in this case, where there's not much more detailed\n"
- "\t\thelp available." }
+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." }
};
+static command_t *
+find_command (const char *name)
+{
+ size_t i;
+
+ 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];
+
+ return NULL;
+}
+
+int notmuch_format_version;
+
static void
-usage (void)
+usage (FILE *out)
{
command_t *command;
unsigned int i;
- fprintf (stderr, "Usage: notmuch <command> [args...]\n");
- fprintf (stderr, "\n");
- fprintf (stderr, "Where <command> and [args...] are as follows:\n");
- fprintf (stderr, "\n");
+ fprintf (out,
+ "Usage: notmuch --help\n"
+ " notmuch --version\n"
+ " notmuch <command> [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];
- fprintf (stderr, "\t%s\t%s\n\n", command->name, command->summary);
+ if (command->name)
+ fprintf (out, " %-11s %s\n", command->name, command->summary);
+ }
+
+ fprintf (out, "\n");
+ fprintf (out,
+ "Use \"notmuch help <command>\" for more details on each command\n"
+ "and \"notmuch help search-terms\" for the common search-terms syntax.\n\n");
+}
+
+void
+notmuch_exit_if_unsupported_format (void)
+{
+ 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);
}
+}
- fprintf (stderr, "Use \"notmuch help <command>\" for more details on each command.\n\n");
+static void
+exec_man (const char *page)
+{
+ if (execlp ("man", "man", page, (char *) NULL)) {
+ perror ("exec man");
+ exit (1);
+ }
}
static int
-notmuch_help_command (unused (void *ctx), int argc, char *argv[])
+notmuch_help_command (notmuch_config_t *config, int argc, char *argv[])
{
command_t *command;
- unsigned int i;
+
+ argc--; argv++; /* Ignore "help" */
if (argc == 0) {
- fprintf (stderr, "The notmuch mail system.\n\n");
- usage ();
- return 0;
+ printf ("The notmuch mail system.\n\n");
+ usage (stdout);
+ return EXIT_SUCCESS;
}
- for (i = 0; i < ARRAY_SIZE (commands); i++) {
- command = &commands[i];
+ 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;
+ }
- if (strcmp (argv[0], command->name) == 0) {
- fprintf (stderr, "Help for \"notmuch %s\":\n\n", argv[0]);
- fprintf (stderr, "\t%s\t%s\n\n%s\n\n", command->name,
- command->summary, command->documentation);
- return 0;
- }
+ command = find_command (argv[0]);
+ if (command) {
+ char *page = talloc_asprintf (config, "notmuch-%s", command->name);
+ exec_man (page);
+ }
+
+ if (strcmp (argv[0], "search-terms") == 0) {
+ exec_man ("notmuch-search-terms");
+ } else if (strcmp (argv[0], "hooks") == 0) {
+ exec_man ("notmuch-hooks");
}
fprintf (stderr,
"\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
argv[0]);
- return 1;
+ return EXIT_FAILURE;
}
/* Handle the case of "notmuch" being invoked with no command
- * argument. Print a welcome and explanatory message, then invoke
- * notmuch_setup_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)
+notmuch_command (notmuch_config_t *config,
+ unused(int argc), unused(char *argv[]))
{
- int ret;
+ char *db_path;
+ struct stat st;
- printf (
-"Welcome to notmuch!\n\n"
-
-"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"
-
-"Notmuch needs to know a few things about you such as your name and email\n"
-"address, as well as the directory that contains your email. This is where\n"
-"you already have mail stored and where messages will be delivered in the\n"
-"future. This directory can contain any number of sub-directories. Regular\n"
-"files in these directories should be individual email messages. If there\n"
-"are other, non-email files (such as indexes maintained by other email\n"
-"programs) then notmuch will do its best to detect those and ignore them.\n\n"
-
-"If you already have your email being delivered to directories in either\n"
-"maildir or mh format, then that's perfect. Mail storage that uses mbox\n"
-"format, (where one mbox file contains many messages), will not work with\n"
-"notmuch. If that's how your mail is currently stored, we recommend you\n"
-"first convert it to maildir format with a utility such as mb2md. You can\n"
-"continue configuring notmuch now, but be sure to complete the conversion\n"
-"before you run \"notmuch new\" for the first time.\n\n");
-
- ret = notmuch_setup_command (ctx, 0, NULL);
-
- printf ("\n"
-"Notmuch is now configured, and the configuration settings are saved in\n"
-"a file in your home directory named .notmuch-config . If you'd like to\n"
-"change the configuration in the future, you can either edit that file\n"
-"directly or run \"notmuch setup\".\n\n"
-
-"The next step is to run \"notmuch new\" which will create a database\n"
-"that indexes all of your mail. Depending on the amount of mail you have\n"
-"the initial indexing process can take a long time, so expect that.\n"
-"Also, the resulting database will require roughly the same amount of\n"
-"storage space as your current collection of email. So please ensure you\n"
-"have sufficient storage space available now.\n\n");
+ /* 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);
- return ret;
+ /* 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;
+ }
+ 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;
+ }
+
+ 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
main (int argc, char *argv[])
{
void *local;
+ char *talloc_report;
+ const char *command_name = NULL;
command_t *command;
- unsigned int i;
+ 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 (0);
+ g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
+#if !GLIB_CHECK_VERSION(2, 35, 1)
+ g_type_init ();
+#endif
- if (argc == 1)
- return notmuch (local);
+ /* Globally default to the current output format version. */
+ notmuch_format_version = NOTMUCH_FORMAT_CUR;
- for (i = 0; i < ARRAY_SIZE (commands); i++) {
- command = &commands[i];
+ opt_index = parse_arguments (argc, argv, options, 1);
+ if (opt_index < 0) {
+ ret = EXIT_FAILURE;
+ goto DONE;
+ }
+
+ if (print_help) {
+ ret = notmuch_help_command (NULL, argc - 1, &argv[1]);
+ goto DONE;
+ }
+
+ if (print_version) {
+ printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
+ ret = EXIT_SUCCESS;
+ goto DONE;
+ }
+
+ if (opt_index < argc)
+ command_name = argv[opt_index];
+
+ command = find_command (command_name);
+ if (!command) {
+ fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
+ command_name);
+ ret = EXIT_FAILURE;
+ goto DONE;
+ }
- if (strcmp (argv[1], command->name) == 0)
- return (command->function) (local, argc - 2, &argv[2]);
+ config = notmuch_config_open (local, config_file_name, command->create_config);
+ if (!config) {
+ ret = EXIT_FAILURE;
+ goto DONE;
}
- /* Don't complain about "help" being an unknown command when we're
- about to provide exactly what's wanted anyway. */
- fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
- argv[1]);
+ ret = (command->function)(config, argc - opt_index, argv + opt_index);
+
+ DONE:
+ if (config)
+ notmuch_config_close (config);
+
+ 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);
+ }
+ }
talloc_free (local);
- return 1;
+ return ret;
}
projects / notmuch / blobdiff