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,
35 int argc, char *argv[]);
37 typedef struct command {
39 command_function_t function;
40 notmuch_command_mode_t mode;
45 notmuch_help_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
48 notmuch_command (notmuch_config_t *config, notmuch_database_t *notmuch, int argc, char *argv[]);
51 _help_for (const char *topic);
53 static bool print_version = false, print_help = false;
54 const char *notmuch_requested_db_uuid = NULL;
56 const notmuch_opt_desc_t notmuch_shared_options [] = {
57 { .opt_bool = &print_version, .name = "version" },
58 { .opt_bool = &print_help, .name = "help" },
59 { .opt_string = ¬much_requested_db_uuid, .name = "uuid" },
63 /* any subcommand wanting to support these options should call
64 * inherit notmuch_shared_options and call
65 * notmuch_process_shared_options (subcommand_name);
68 notmuch_process_shared_options (const char *subcommand_name)
71 printf ("notmuch " STRINGIFY (NOTMUCH_VERSION) "\n");
76 int ret = _help_for (subcommand_name);
81 /* This is suitable for subcommands that do not actually open the
85 notmuch_minimal_options (const char *subcommand_name,
86 int argc, char **argv)
90 notmuch_opt_desc_t options[] = {
91 { .opt_inherit = notmuch_shared_options },
95 opt_index = parse_arguments (argc, argv, options, 1);
100 /* We can't use argv here as it is sometimes NULL */
101 notmuch_process_shared_options (subcommand_name);
106 struct _notmuch_client_indexing_cli_choices indexing_cli_choices = { };
107 const notmuch_opt_desc_t notmuch_shared_indexing_options [] = {
108 { .opt_keyword = &indexing_cli_choices.decrypt_policy,
109 .present = &indexing_cli_choices.decrypt_policy_set, .keywords =
110 (notmuch_keyword_t []){ { "false", NOTMUCH_DECRYPT_FALSE },
111 { "true", NOTMUCH_DECRYPT_TRUE },
112 { "auto", NOTMUCH_DECRYPT_AUTO },
113 { "nostash", NOTMUCH_DECRYPT_NOSTASH },
121 notmuch_process_shared_indexing_options (notmuch_database_t *notmuch)
123 if (indexing_cli_choices.opts == NULL)
124 indexing_cli_choices.opts = notmuch_database_get_default_indexopts (notmuch);
125 if (indexing_cli_choices.decrypt_policy_set) {
126 notmuch_status_t status;
127 if (indexing_cli_choices.opts == NULL)
128 return NOTMUCH_STATUS_OUT_OF_MEMORY;
129 status = notmuch_indexopts_set_decrypt_policy (indexing_cli_choices.opts,
130 indexing_cli_choices.decrypt_policy);
131 if (status != NOTMUCH_STATUS_SUCCESS) {
132 fprintf (stderr, "Error: Failed to set index decryption policy to %d. (%s)\n",
133 indexing_cli_choices.decrypt_policy, notmuch_status_to_string (status));
134 notmuch_indexopts_destroy (indexing_cli_choices.opts);
135 indexing_cli_choices.opts = NULL;
139 return NOTMUCH_STATUS_SUCCESS;
143 static command_t commands[] = {
144 { NULL, notmuch_command, NOTMUCH_COMMAND_CONFIG_OPEN | NOTMUCH_COMMAND_CONFIG_CREATE
145 | NOTMUCH_COMMAND_CONFIG_LOAD,
146 "Notmuch main command." },
147 { "setup", notmuch_setup_command, NOTMUCH_COMMAND_CONFIG_OPEN | NOTMUCH_COMMAND_CONFIG_CREATE
148 | NOTMUCH_COMMAND_CONFIG_LOAD,
149 "Interactively set up notmuch for first use." },
150 { "new", notmuch_new_command,
151 NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE |
152 NOTMUCH_COMMAND_DATABASE_CREATE,
153 "Find and import new messages to the notmuch database." },
154 { "insert", notmuch_insert_command, NOTMUCH_COMMAND_DATABASE_EARLY |
155 NOTMUCH_COMMAND_DATABASE_WRITE,
156 "Add a new message into the maildir and notmuch database." },
157 { "search", notmuch_search_command, NOTMUCH_COMMAND_DATABASE_EARLY,
158 "Search for messages matching the given search terms." },
159 { "address", notmuch_address_command, NOTMUCH_COMMAND_DATABASE_EARLY,
160 "Get addresses from messages matching the given search terms." },
161 { "show", notmuch_show_command, NOTMUCH_COMMAND_DATABASE_EARLY,
162 "Show all messages matching the search terms." },
163 { "count", notmuch_count_command, NOTMUCH_COMMAND_DATABASE_EARLY,
164 "Count messages matching the search terms." },
165 { "reply", notmuch_reply_command, NOTMUCH_COMMAND_DATABASE_EARLY,
166 "Construct a reply template for a set of messages." },
167 { "tag", notmuch_tag_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
168 "Add/remove tags for all messages matching the search terms." },
169 { "dump", notmuch_dump_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
170 "Create a plain-text dump of the tags for each message." },
171 { "restore", notmuch_restore_command, NOTMUCH_COMMAND_DATABASE_EARLY |
172 NOTMUCH_COMMAND_DATABASE_WRITE,
173 "Restore the tags from the given dump file (see 'dump')." },
174 { "compact", notmuch_compact_command, NOTMUCH_COMMAND_DATABASE_EARLY |
175 NOTMUCH_COMMAND_DATABASE_WRITE,
176 "Compact the notmuch database." },
177 { "reindex", notmuch_reindex_command, NOTMUCH_COMMAND_DATABASE_EARLY |
178 NOTMUCH_COMMAND_DATABASE_WRITE,
179 "Re-index all messages matching the search terms." },
180 { "config", notmuch_config_command, NOTMUCH_COMMAND_CONFIG_OPEN | NOTMUCH_COMMAND_CONFIG_LOAD,
181 "Get or set settings in the notmuch configuration file." },
183 { "emacs-mua", NULL, 0,
184 "send mail with notmuch and emacs." },
186 { "help", notmuch_help_command, NOTMUCH_COMMAND_CONFIG_CREATE, /* create but don't save config */
187 "This message, or more detailed help for the named command." }
190 typedef struct help_topic {
195 static help_topic_t help_topics[] = {
197 "Common search term syntax." },
199 "Hooks that will be run before or after certain commands." },
201 "Message property conventions and documentation." },
205 find_command (const char *name)
209 for (i = 0; i < ARRAY_SIZE (commands); i++)
210 if ((! name && ! commands[i].name) ||
211 (name && commands[i].name && strcmp (name, commands[i].name) == 0))
217 int notmuch_format_version;
227 "Usage: notmuch --help\n"
228 " notmuch --version\n"
229 " notmuch <command> [args...]\n");
231 fprintf (out, "The available commands are as follows:\n");
234 for (i = 0; i < ARRAY_SIZE (commands); i++) {
235 command = &commands[i];
238 fprintf (out, " %-12s %s\n", command->name, command->summary);
242 fprintf (out, "Additional help topics are as follows:\n");
245 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
246 topic = &help_topics[i];
247 fprintf (out, " %-12s %s\n", topic->name, topic->summary);
252 "Use \"notmuch help <command or topic>\" for more details "
253 "on each command or topic.\n\n");
257 notmuch_exit_if_unsupported_format (void)
259 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
262 A caller requested output format version %d, but the installed notmuch\n\
263 CLI only supports up to format version %d. You may need to upgrade your\n\
265 notmuch_format_version, NOTMUCH_FORMAT_CUR);
266 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
267 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
270 A caller requested output format version %d, which is no longer supported\n\
271 by the notmuch CLI (it requires at least version %d). You may need to\n\
272 upgrade your notmuch front-end.\n",
273 notmuch_format_version, NOTMUCH_FORMAT_MIN);
274 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
275 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
276 /* Warn about old version requests so compatibility issues are
277 * less likely when we drop support for a deprecated format
281 A caller requested deprecated output format version %d, which may not\n\
282 be supported in the future.\n", notmuch_format_version);
287 notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
289 const char *uuid = NULL;
291 if (! notmuch_requested_db_uuid)
293 IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));
295 if (strcmp (notmuch_requested_db_uuid, uuid) != 0) {
296 fprintf (stderr, "Error: requested database revision %s does not match %s\n",
297 notmuch_requested_db_uuid, uuid);
303 exec_man (const char *page)
305 if (execlp ("man", "man", page, (char *) NULL)) {
312 _help_for (const char *topic_name)
319 printf ("The notmuch mail system.\n\n");
324 if (strcmp (topic_name, "help") == 0) {
325 printf ("The notmuch help system.\n\n"
326 "\tNotmuch uses the man command to display help. In case\n"
327 "\tof difficulties check that MANPATH includes the pages\n"
328 "\tinstalled by notmuch.\n\n"
329 "\tTry \"notmuch help\" for a list of topics.\n");
333 command = find_command (topic_name);
335 char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
339 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
340 topic = &help_topics[i];
341 if (strcmp (topic_name, topic->name) == 0) {
342 char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);
348 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
354 notmuch_help_command (unused (notmuch_config_t *config), unused(notmuch_database_t *notmuch), int
359 opt_index = notmuch_minimal_options ("help", argc, argv);
363 /* skip at least subcommand argument */
368 return _help_for (NULL);
371 return _help_for (argv[0]);
374 /* Handle the case of "notmuch" being invoked with no command
375 * argument. For now we just call notmuch_setup_command, but we plan
376 * to be more clever about this in the future.
379 notmuch_command (notmuch_config_t *config,
380 notmuch_database_t *notmuch,
381 unused(int argc), unused(char **argv))
383 /* If the user has never configured notmuch, then run
384 * notmuch_setup_command which will give a nice welcome message,
385 * and interactively guide the user through the configuration. */
386 if (notmuch_config_is_new (config))
387 return notmuch_setup_command (config, notmuch, 0, NULL);
389 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
390 "At this point you can start exploring the functionality of notmuch by\n"
391 "using commands such as:\n\n"
392 "\tnotmuch search tag:inbox\n\n"
393 "\tnotmuch search to:\"%s\"\n\n"
394 "\tnotmuch search from:\"%s\"\n\n"
395 "\tnotmuch search subject:\"my favorite things\"\n\n"
396 "See \"notmuch help search\" for more details.\n\n"
397 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
398 "from a search. Finally, you may want to explore using a more sophisticated\n"
399 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
400 "or any other interface described at https://notmuchmail.org\n\n"
401 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
402 "Have fun, and may your inbox never have much mail.\n\n",
403 notmuch_config_get (notmuch, NOTMUCH_CONFIG_USER_NAME),
404 notmuch_config_get (notmuch, NOTMUCH_CONFIG_PRIMARY_EMAIL));
410 * Try to run subcommand in argv[0] as notmuch- prefixed external
411 * command. argv must be NULL terminated (argv passed to main always
414 * Does not return if the external command is found and
415 * executed. Return true if external command is not found. Return
419 try_external_command (char *argv[])
421 char *old_argv0 = argv[0];
424 argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);
427 * This will only return on errors. Not finding an external
428 * command (ENOENT) is not an error from our perspective.
430 execvp (argv[0], argv);
431 if (errno != ENOENT) {
432 fprintf (stderr, "Error: Running external command '%s' failed: %s\n",
433 argv[0], strerror (errno));
437 talloc_free (argv[0]);
444 main (int argc, char *argv[])
448 const char *command_name = NULL;
450 const char *config_file_name = NULL;
451 notmuch_config_t *config = NULL;
452 notmuch_database_t *notmuch = NULL;
454 int ret = EXIT_SUCCESS;
456 notmuch_opt_desc_t options[] = {
457 { .opt_string = &config_file_name, .name = "config", .allow_empty = TRUE },
458 { .opt_inherit = notmuch_shared_options },
462 talloc_enable_null_tracking ();
464 local = talloc_new (NULL);
467 #if ! GLIB_CHECK_VERSION (2, 35, 1)
471 /* Globally default to the current output format version. */
472 notmuch_format_version = NOTMUCH_FORMAT_CUR;
474 opt_index = parse_arguments (argc, argv, options, 1);
480 if (opt_index < argc)
481 command_name = argv[opt_index];
483 notmuch_process_shared_options (command_name);
485 command = find_command (command_name);
486 /* if command->function is NULL, try external command */
487 if (! command || ! command->function) {
488 /* This won't return if the external command is found. */
489 if (try_external_command (argv + opt_index))
490 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
496 if (command->mode & NOTMUCH_COMMAND_DATABASE_EARLY) {
497 char *status_string = NULL;
498 notmuch_database_mode_t mode;
499 notmuch_status_t status;
501 if (command->mode & NOTMUCH_COMMAND_DATABASE_WRITE ||
502 command->mode & NOTMUCH_COMMAND_DATABASE_CREATE)
503 mode = NOTMUCH_DATABASE_MODE_READ_WRITE;
505 mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
507 if (command->mode & NOTMUCH_COMMAND_DATABASE_CREATE) {
508 status = notmuch_database_create_with_config (NULL,
513 if (status && status != NOTMUCH_STATUS_DATABASE_EXISTS) {
515 fputs (status_string, stderr);
516 free (status_string);
519 if (status == NOTMUCH_STATUS_NO_CONFIG)
520 fputs ("Try running 'notmuch setup' to create a configuration.", stderr);
526 if (notmuch == NULL) {
527 status = notmuch_database_open_with_config (NULL,
535 fputs (status_string, stderr);
536 free (status_string);
544 if (command->mode & NOTMUCH_COMMAND_CONFIG_LOAD) {
545 char *status_string = NULL;
546 notmuch_status_t status;
547 status = notmuch_database_load_config (NULL,
553 if (status == NOTMUCH_STATUS_NO_CONFIG && ! (command->mode & NOTMUCH_COMMAND_CONFIG_CREATE)) {
554 fputs ("Try running 'notmuch setup' to create a configuration.", stderr);
558 case NOTMUCH_STATUS_NO_CONFIG:
559 if (! (command->mode & NOTMUCH_COMMAND_CONFIG_CREATE)) {
560 fputs ("Try running 'notmuch setup' to create a configuration.", stderr);
564 case NOTMUCH_STATUS_NO_DATABASE:
565 if (! command_name) {
566 printf ("Notmuch is configured, but no database was found.\n");
567 printf ("You probably want to run \"notmuch new\" now to create a database.\n\n"
568 "Note that the first run of \"notmuch new\" can take a very long time\n"
569 "and that the resulting database will use roughly the same amount of\n"
570 "storage space as the email being indexed.\n\n");
571 status = NOTMUCH_STATUS_SUCCESS;
575 case NOTMUCH_STATUS_SUCCESS:
583 if (command->mode & NOTMUCH_COMMAND_CONFIG_OPEN) {
584 if (! config_file_name)
585 config_file_name = notmuch_config_path (notmuch);
587 config = notmuch_config_open (notmuch, config_file_name, command->mode);
593 ret = (command->function)(config, notmuch, argc - opt_index, argv + opt_index);
597 notmuch_config_close (config);
599 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
600 if (talloc_report && strcmp (talloc_report, "") != 0) {
601 /* this relies on the previous call to
602 * talloc_enable_null_tracking
605 FILE *report = fopen (talloc_report, "w");
607 talloc_report_full (NULL, report);
610 fprintf (stderr, "ERROR: unable to write talloc log. ");
611 perror (talloc_report);