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_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_database_t *notmuch, int argc, char *argv[]);
47 notmuch_command (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,
129 indexing_cli_choices.decrypt_policy);
130 if (status != NOTMUCH_STATUS_SUCCESS) {
131 fprintf (stderr, "Error: Failed to set index decryption policy to %d. (%s)\n",
132 indexing_cli_choices.decrypt_policy, notmuch_status_to_string (status));
133 notmuch_indexopts_destroy (indexing_cli_choices.opts);
134 indexing_cli_choices.opts = NULL;
138 return NOTMUCH_STATUS_SUCCESS;
142 static const command_t commands[] = {
143 { NULL, notmuch_command, NOTMUCH_COMMAND_CONFIG_CREATE | NOTMUCH_COMMAND_CONFIG_LOAD,
144 "Notmuch main command." },
145 { "setup", notmuch_setup_command, NOTMUCH_COMMAND_CONFIG_CREATE | NOTMUCH_COMMAND_CONFIG_LOAD,
146 "Interactively set up notmuch for first use." },
147 { "new", notmuch_new_command,
148 NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE |
149 NOTMUCH_COMMAND_DATABASE_CREATE,
150 "Find and import new messages to the notmuch database." },
151 { "insert", notmuch_insert_command, NOTMUCH_COMMAND_DATABASE_EARLY |
152 NOTMUCH_COMMAND_DATABASE_WRITE,
153 "Add a new message into the maildir and notmuch database." },
154 { "search", notmuch_search_command, NOTMUCH_COMMAND_DATABASE_EARLY,
155 "Search for messages matching the given search terms." },
156 { "address", notmuch_address_command, NOTMUCH_COMMAND_DATABASE_EARLY,
157 "Get addresses from messages matching the given search terms." },
158 { "show", notmuch_show_command, NOTMUCH_COMMAND_DATABASE_EARLY,
159 "Show all messages matching the search terms." },
160 { "count", notmuch_count_command, NOTMUCH_COMMAND_DATABASE_EARLY,
161 "Count messages matching the search terms." },
162 { "reply", notmuch_reply_command, NOTMUCH_COMMAND_DATABASE_EARLY,
163 "Construct a reply template for a set of messages." },
164 { "tag", notmuch_tag_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
165 "Add/remove tags for all messages matching the search terms." },
166 { "dump", notmuch_dump_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
167 "Create a plain-text dump of the tags for each message." },
168 { "restore", notmuch_restore_command, NOTMUCH_COMMAND_DATABASE_EARLY |
169 NOTMUCH_COMMAND_DATABASE_WRITE,
170 "Restore the tags from the given dump file (see 'dump')." },
171 { "compact", notmuch_compact_command, NOTMUCH_COMMAND_DATABASE_EARLY |
172 NOTMUCH_COMMAND_DATABASE_WRITE,
173 "Compact the notmuch database." },
174 { "reindex", notmuch_reindex_command, NOTMUCH_COMMAND_DATABASE_EARLY |
175 NOTMUCH_COMMAND_DATABASE_WRITE,
176 "Re-index all messages matching the search terms." },
177 { "config", notmuch_config_command, NOTMUCH_COMMAND_CONFIG_LOAD,
178 "Get or set settings in the notmuch configuration file." },
180 { "emacs-mua", NULL, 0,
181 "send mail with notmuch and emacs." },
183 { "help", notmuch_help_command, NOTMUCH_COMMAND_CONFIG_CREATE, /* create but don't save config */
184 "This message, or more detailed help for the named command." }
187 typedef struct help_topic {
192 static const help_topic_t help_topics[] = {
194 "Common search term syntax." },
196 "Hooks that will be run before or after certain commands." },
198 "Message property conventions and documentation." },
201 static const command_t *
202 find_command (const char *name)
206 for (i = 0; i < ARRAY_SIZE (commands); i++)
207 if ((! name && ! commands[i].name) ||
208 (name && commands[i].name && strcmp (name, commands[i].name) == 0))
214 int notmuch_format_version;
219 const command_t *command;
220 const help_topic_t *topic;
224 "Usage: notmuch --help\n"
225 " notmuch --version\n"
226 " notmuch <command> [args...]\n");
228 fprintf (out, "The available commands are as follows:\n");
231 for (i = 0; i < ARRAY_SIZE (commands); i++) {
232 command = &commands[i];
235 fprintf (out, " %-12s %s\n", command->name, command->summary);
239 fprintf (out, "Additional help topics are as follows:\n");
242 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
243 topic = &help_topics[i];
244 fprintf (out, " %-12s %s\n", topic->name, topic->summary);
249 "Use \"notmuch help <command or topic>\" for more details "
250 "on each command or topic.\n\n");
254 notmuch_exit_if_unsupported_format (void)
256 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
259 A caller requested output format version %d, but the installed notmuch\n\
260 CLI only supports up to format version %d. You may need to upgrade your\n\
262 notmuch_format_version, NOTMUCH_FORMAT_CUR);
263 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
264 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
267 A caller requested output format version %d, which is no longer supported\n\
268 by the notmuch CLI (it requires at least version %d). You may need to\n\
269 upgrade your notmuch front-end.\n",
270 notmuch_format_version, NOTMUCH_FORMAT_MIN);
271 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
272 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
273 /* Warn about old version requests so compatibility issues are
274 * less likely when we drop support for a deprecated format
278 A caller requested deprecated output format version %d, which may not\n\
279 be supported in the future.\n", notmuch_format_version);
284 notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
286 const char *uuid = NULL;
288 if (! notmuch_requested_db_uuid)
290 IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));
292 if (strcmp (notmuch_requested_db_uuid, uuid) != 0) {
293 fprintf (stderr, "Error: requested database revision %s does not match %s\n",
294 notmuch_requested_db_uuid, uuid);
300 exec_man (const char *page)
302 if (execlp ("man", "man", page, (char *) NULL)) {
309 _help_for (const char *topic_name)
311 const command_t *command;
312 const help_topic_t *topic;
316 printf ("The notmuch mail system.\n\n");
321 if (strcmp (topic_name, "help") == 0) {
322 printf ("The notmuch help system.\n\n"
323 "\tNotmuch uses the man command to display help. In case\n"
324 "\tof difficulties check that MANPATH includes the pages\n"
325 "\tinstalled by notmuch.\n\n"
326 "\tTry \"notmuch help\" for a list of topics.\n");
330 command = find_command (topic_name);
332 char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
336 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
337 topic = &help_topics[i];
338 if (strcmp (topic_name, topic->name) == 0) {
339 char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);
345 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
351 notmuch_help_command (unused(notmuch_database_t *notmuch), int argc, char *argv[])
355 opt_index = notmuch_minimal_options ("help", argc, argv);
359 /* skip at least subcommand argument */
364 return _help_for (NULL);
367 return _help_for (argv[0]);
370 /* Handle the case of "notmuch" being invoked with no command
371 * argument. For now we just call notmuch_setup_command, but we plan
372 * to be more clever about this in the future.
375 notmuch_command (notmuch_database_t *notmuch,
376 unused(int argc), unused(char **argv))
379 const char *config_path;
381 /* If the user has not created a configuration file, then run
382 * notmuch_setup_command which will give a nice welcome message,
383 * and interactively guide the user through the configuration. */
384 config_path = notmuch_config_path (notmuch);
385 if (access (config_path, R_OK | F_OK) == -1) {
386 if (errno != ENOENT) {
387 fprintf (stderr, "Error: %s config file access failed: %s\n", config_path,
391 return notmuch_setup_command (notmuch, 0, NULL);
395 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
396 "At this point you can start exploring the functionality of notmuch by\n"
397 "using commands such as:\n\n"
398 "\tnotmuch search tag:inbox\n\n"
399 "\tnotmuch search to:\"%s\"\n\n"
400 "\tnotmuch search from:\"%s\"\n\n"
401 "\tnotmuch search subject:\"my favorite things\"\n\n"
402 "See \"notmuch help search\" for more details.\n\n"
403 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
404 "from a search. Finally, you may want to explore using a more sophisticated\n"
405 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
406 "or any other interface described at https://notmuchmail.org\n\n"
407 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
408 "Have fun, and may your inbox never have much mail.\n\n",
409 notmuch_config_get (notmuch, NOTMUCH_CONFIG_USER_NAME),
410 notmuch_config_get (notmuch, NOTMUCH_CONFIG_PRIMARY_EMAIL));
416 * Try to run subcommand in argv[0] as notmuch- prefixed external
417 * command. argv must be NULL terminated (argv passed to main always
420 * Does not return if the external command is found and
421 * executed. Return true if external command is not found. Return
425 try_external_command (char *argv[])
427 char *old_argv0 = argv[0];
430 argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);
433 * This will only return on errors. Not finding an external
434 * command (ENOENT) is not an error from our perspective.
436 execvp (argv[0], argv);
437 if (errno != ENOENT) {
438 fprintf (stderr, "Error: Running external command '%s' failed: %s\n",
439 argv[0], strerror (errno));
443 talloc_free (argv[0]);
450 main (int argc, char *argv[])
454 const char *command_name = NULL;
455 const command_t *command;
456 const char *config_file_name = NULL;
457 notmuch_database_t *notmuch = NULL;
459 int ret = EXIT_SUCCESS;
461 notmuch_opt_desc_t options[] = {
462 { .opt_string = &config_file_name, .name = "config", .allow_empty = TRUE },
463 { .opt_inherit = notmuch_shared_options },
467 notmuch_client_init ();
469 local = talloc_new (NULL);
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 ret = (command->function)(notmuch, argc - opt_index, argv + opt_index);
586 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
587 if (talloc_report && strcmp (talloc_report, "") != 0) {
588 /* this relies on the previous call to
589 * talloc_enable_null_tracking
592 FILE *report = fopen (talloc_report, "a");
594 talloc_report_full (NULL, report);
597 fprintf (stderr, "ERROR: unable to write talloc log. ");
598 perror (talloc_report);