1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
4 * Copyright © 2009 Keith Packard
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see https://www.gnu.org/licenses/ .
19 * Authors: Carl Worth <cworth@cworth.org>
20 * Keith Packard <keithp@keithp.com>
23 #include "notmuch-client.h"
26 * Notmuch subcommand hook.
28 * The return value will be used as notmuch exit status code,
29 * preferably EXIT_SUCCESS or EXIT_FAILURE.
31 * Each subcommand should be passed either a config object, or an open
34 typedef int (*command_function_t) (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
36 typedef struct command {
38 command_function_t function;
39 notmuch_command_mode_t mode;
44 notmuch_help_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
47 notmuch_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
50 _help_for (const char *topic);
52 static bool print_version = false, print_help = false;
53 const char *notmuch_requested_db_uuid = NULL;
55 const notmuch_opt_desc_t notmuch_shared_options [] = {
56 { .opt_bool = &print_version, .name = "version" },
57 { .opt_bool = &print_help, .name = "help" },
58 { .opt_string = ¬much_requested_db_uuid, .name = "uuid" },
62 /* any subcommand wanting to support these options should call
63 * inherit notmuch_shared_options and call
64 * notmuch_process_shared_options (subcommand_name);
67 notmuch_process_shared_options (const char *subcommand_name)
70 printf ("notmuch " STRINGIFY (NOTMUCH_VERSION) "\n");
75 int ret = _help_for (subcommand_name);
80 /* This is suitable for subcommands that do not actually open the
84 notmuch_minimal_options (const char *subcommand_name,
85 int argc, char **argv)
89 notmuch_opt_desc_t options[] = {
90 { .opt_inherit = notmuch_shared_options },
94 opt_index = parse_arguments (argc, argv, options, 1);
99 /* We can't use argv here as it is sometimes NULL */
100 notmuch_process_shared_options (subcommand_name);
105 struct _notmuch_client_indexing_cli_choices indexing_cli_choices = { };
106 const notmuch_opt_desc_t notmuch_shared_indexing_options [] = {
107 { .opt_keyword = &indexing_cli_choices.decrypt_policy,
108 .present = &indexing_cli_choices.decrypt_policy_set, .keywords =
109 (notmuch_keyword_t []){ { "false", NOTMUCH_DECRYPT_FALSE },
110 { "true", NOTMUCH_DECRYPT_TRUE },
111 { "auto", NOTMUCH_DECRYPT_AUTO },
112 { "nostash", NOTMUCH_DECRYPT_NOSTASH },
120 notmuch_process_shared_indexing_options (notmuch_database_t *notmuch)
122 if (indexing_cli_choices.opts == NULL)
123 indexing_cli_choices.opts = notmuch_database_get_default_indexopts (notmuch);
124 if (indexing_cli_choices.decrypt_policy_set) {
125 notmuch_status_t status;
126 if (indexing_cli_choices.opts == NULL)
127 return NOTMUCH_STATUS_OUT_OF_MEMORY;
128 status = notmuch_indexopts_set_decrypt_policy (indexing_cli_choices.opts, indexing_cli_choices.decrypt_policy);
129 if (status != NOTMUCH_STATUS_SUCCESS) {
130 fprintf (stderr, "Error: Failed to set index decryption policy to %d. (%s)\n",
131 indexing_cli_choices.decrypt_policy, notmuch_status_to_string (status));
132 notmuch_indexopts_destroy (indexing_cli_choices.opts);
133 indexing_cli_choices.opts = NULL;
137 return NOTMUCH_STATUS_SUCCESS;
141 static command_t commands[] = {
142 { NULL, notmuch_command, NOTMUCH_COMMAND_CONFIG_OPEN | NOTMUCH_COMMAND_CONFIG_CREATE,
143 "Notmuch main command." },
144 { "setup", notmuch_setup_command, NOTMUCH_COMMAND_CONFIG_OPEN | NOTMUCH_COMMAND_CONFIG_CREATE,
145 "Interactively set up notmuch for first use." },
146 { "new", notmuch_new_command, NOTMUCH_COMMAND_CONFIG_OPEN,
147 "Find and import new messages to the notmuch database." },
148 { "insert", notmuch_insert_command, NOTMUCH_COMMAND_CONFIG_OPEN,
149 "Add a new message into the maildir and notmuch database." },
150 { "search", notmuch_search_command, NOTMUCH_COMMAND_CONFIG_OPEN,
151 "Search for messages matching the given search terms." },
152 { "address", notmuch_address_command, NOTMUCH_COMMAND_CONFIG_OPEN,
153 "Get addresses from messages matching the given search terms." },
154 { "show", notmuch_show_command, NOTMUCH_COMMAND_CONFIG_OPEN,
155 "Show all messages matching the search terms." },
156 { "count", notmuch_count_command, NOTMUCH_COMMAND_CONFIG_OPEN,
157 "Count messages matching the search terms." },
158 { "reply", notmuch_reply_command, NOTMUCH_COMMAND_CONFIG_OPEN,
159 "Construct a reply template for a set of messages." },
160 { "tag", notmuch_tag_command, NOTMUCH_COMMAND_CONFIG_OPEN,
161 "Add/remove tags for all messages matching the search terms." },
162 { "dump", notmuch_dump_command, NOTMUCH_COMMAND_CONFIG_OPEN,
163 "Create a plain-text dump of the tags for each message." },
164 { "restore", notmuch_restore_command, NOTMUCH_COMMAND_CONFIG_OPEN,
165 "Restore the tags from the given dump file (see 'dump')." },
166 { "compact", notmuch_compact_command, NOTMUCH_COMMAND_CONFIG_OPEN,
167 "Compact the notmuch database." },
168 { "reindex", notmuch_reindex_command, NOTMUCH_COMMAND_CONFIG_OPEN,
169 "Re-index all messages matching the search terms." },
170 { "config", notmuch_config_command, NOTMUCH_COMMAND_CONFIG_OPEN,
171 "Get or set settings in the notmuch configuration file." },
173 { "emacs-mua", NULL, 0,
174 "send mail with notmuch and emacs." },
176 { "help", notmuch_help_command, NOTMUCH_COMMAND_CONFIG_CREATE, /* create but don't save config */
177 "This message, or more detailed help for the named command." }
180 typedef struct help_topic {
185 static help_topic_t help_topics[] = {
187 "Common search term syntax." },
189 "Hooks that will be run before or after certain commands." },
191 "Message property conventions and documentation." },
195 find_command (const char *name)
199 for (i = 0; i < ARRAY_SIZE (commands); i++)
200 if ((! name && ! commands[i].name) ||
201 (name && commands[i].name && strcmp (name, commands[i].name) == 0))
207 int notmuch_format_version;
217 "Usage: notmuch --help\n"
218 " notmuch --version\n"
219 " notmuch <command> [args...]\n");
221 fprintf (out, "The available commands are as follows:\n");
224 for (i = 0; i < ARRAY_SIZE (commands); i++) {
225 command = &commands[i];
228 fprintf (out, " %-12s %s\n", command->name, command->summary);
232 fprintf (out, "Additional help topics are as follows:\n");
235 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
236 topic = &help_topics[i];
237 fprintf (out, " %-12s %s\n", topic->name, topic->summary);
242 "Use \"notmuch help <command or topic>\" for more details "
243 "on each command or topic.\n\n");
247 notmuch_exit_if_unsupported_format (void)
249 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
251 A caller requested output format version %d, but the installed notmuch\n\
252 CLI only supports up to format version %d. You may need to upgrade your\n\
254 notmuch_format_version, NOTMUCH_FORMAT_CUR);
255 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
256 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
258 A caller requested output format version %d, which is no longer supported\n\
259 by the notmuch CLI (it requires at least version %d). You may need to\n\
260 upgrade your notmuch front-end.\n",
261 notmuch_format_version, NOTMUCH_FORMAT_MIN);
262 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
263 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
264 /* Warn about old version requests so compatibility issues are
265 * less likely when we drop support for a deprecated format
268 A caller requested deprecated output format version %d, which may not\n\
269 be supported in the future.\n", notmuch_format_version);
274 notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
276 const char *uuid = NULL;
278 if (! notmuch_requested_db_uuid)
280 IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));
282 if (strcmp (notmuch_requested_db_uuid, uuid) != 0) {
283 fprintf (stderr, "Error: requested database revision %s does not match %s\n",
284 notmuch_requested_db_uuid, uuid);
290 exec_man (const char *page)
292 if (execlp ("man", "man", page, (char *) NULL)) {
299 _help_for (const char *topic_name)
306 printf ("The notmuch mail system.\n\n");
311 if (strcmp (topic_name, "help") == 0) {
312 printf ("The notmuch help system.\n\n"
313 "\tNotmuch uses the man command to display help. In case\n"
314 "\tof difficulties check that MANPATH includes the pages\n"
315 "\tinstalled by notmuch.\n\n"
316 "\tTry \"notmuch help\" for a list of topics.\n");
320 command = find_command (topic_name);
322 char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
326 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
327 topic = &help_topics[i];
328 if (strcmp (topic_name, topic->name) == 0) {
329 char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);
335 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
341 notmuch_help_command (unused (notmuch_config_t *config), unused(notmuch_database_t *notmuch), int argc, char *argv[])
345 opt_index = notmuch_minimal_options ("help", argc, argv);
349 /* skip at least subcommand argument */
354 return _help_for (NULL);
357 return _help_for (argv[0]);
360 /* Handle the case of "notmuch" being invoked with no command
361 * argument. For now we just call notmuch_setup_command, but we plan
362 * to be more clever about this in the future.
365 notmuch_command (notmuch_config_t *config,
366 unused(notmuch_database_t *notmuch),
367 unused(int argc), unused(char **argv))
372 /* If the user has never configured notmuch, then run
373 * notmuch_setup_command which will give a nice welcome message,
374 * and interactively guide the user through the configuration. */
375 if (notmuch_config_is_new (config))
376 return notmuch_setup_command (config, NULL, 0, NULL);
378 /* Notmuch is already configured, but is there a database? */
379 db_path = talloc_asprintf (config, "%s/%s",
380 notmuch_config_get_database_path (config),
382 if (stat (db_path, &st)) {
383 if (errno != ENOENT) {
384 fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
385 db_path, strerror (errno));
388 printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
390 printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
391 "Note that the first run of \"notmuch new\" can take a very long time\n"
392 "and that the resulting database will use roughly the same amount of\n"
393 "storage space as the email being indexed.\n\n");
397 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
398 "At this point you can start exploring the functionality of notmuch by\n"
399 "using commands such as:\n\n"
400 "\tnotmuch search tag:inbox\n\n"
401 "\tnotmuch search to:\"%s\"\n\n"
402 "\tnotmuch search from:\"%s\"\n\n"
403 "\tnotmuch search subject:\"my favorite things\"\n\n"
404 "See \"notmuch help search\" for more details.\n\n"
405 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
406 "from a search. Finally, you may want to explore using a more sophisticated\n"
407 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
408 "or any other interface described at https://notmuchmail.org\n\n"
409 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
410 "Have fun, and may your inbox never have much mail.\n\n",
411 notmuch_config_get_user_name (config),
412 notmuch_config_get_user_primary_email (config));
418 * Try to run subcommand in argv[0] as notmuch- prefixed external
419 * command. argv must be NULL terminated (argv passed to main always
422 * Does not return if the external command is found and
423 * executed. Return true if external command is not found. Return
427 try_external_command (char *argv[])
429 char *old_argv0 = argv[0];
432 argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);
435 * This will only return on errors. Not finding an external
436 * command (ENOENT) is not an error from our perspective.
438 execvp (argv[0], argv);
439 if (errno != ENOENT) {
440 fprintf (stderr, "Error: Running external command '%s' failed: %s\n",
441 argv[0], strerror (errno));
445 talloc_free (argv[0]);
452 main (int argc, char *argv[])
456 const char *command_name = NULL;
458 const char *config_file_name = NULL;
459 notmuch_config_t *config = NULL;
460 notmuch_database_t *notmuch = NULL;
464 notmuch_opt_desc_t options[] = {
465 { .opt_string = &config_file_name, .name = "config" },
466 { .opt_inherit = notmuch_shared_options },
470 talloc_enable_null_tracking ();
472 local = talloc_new (NULL);
475 #if ! GLIB_CHECK_VERSION (2, 35, 1)
479 /* Globally default to the current output format version. */
480 notmuch_format_version = NOTMUCH_FORMAT_CUR;
482 opt_index = parse_arguments (argc, argv, options, 1);
488 if (opt_index < argc)
489 command_name = argv[opt_index];
491 notmuch_process_shared_options (command_name);
493 command = find_command (command_name);
494 /* if command->function is NULL, try external command */
495 if (! command || ! command->function) {
496 /* This won't return if the external command is found. */
497 if (try_external_command (argv + opt_index))
498 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
504 if (command->mode & NOTMUCH_COMMAND_DATABASE_EARLY) {
505 char *status_string = NULL;
506 notmuch_database_mode_t mode;
507 if (command->mode & NOTMUCH_COMMAND_DATABASE_WRITE)
508 mode = NOTMUCH_DATABASE_MODE_READ_WRITE;
510 mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
512 if (notmuch_database_open_with_config (NULL,
519 fputs (status_string, stderr);
520 free (status_string);
526 config = notmuch_config_open (local, config_file_name, command->mode);
532 ret = (command->function)(config, notmuch, argc - opt_index, argv + opt_index);
536 notmuch_config_close (config);
538 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
539 if (talloc_report && strcmp (talloc_report, "") != 0) {
540 /* this relies on the previous call to
541 * talloc_enable_null_tracking
544 FILE *report = fopen (talloc_report, "w");
546 talloc_report_full (NULL, report);
549 fprintf (stderr, "ERROR: unable to write talloc log. ");
550 perror (talloc_report);