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,
147 NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE | NOTMUCH_COMMAND_DATABASE_CREATE,
148 "Find and import new messages to the notmuch database." },
149 { "insert", notmuch_insert_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
150 "Add a new message into the maildir and notmuch database." },
151 { "search", notmuch_search_command, NOTMUCH_COMMAND_DATABASE_EARLY,
152 "Search for messages matching the given search terms." },
153 { "address", notmuch_address_command, NOTMUCH_COMMAND_DATABASE_EARLY,
154 "Get addresses from messages matching the given search terms." },
155 { "show", notmuch_show_command, NOTMUCH_COMMAND_CONFIG_OPEN,
156 "Show all messages matching the search terms." },
157 { "count", notmuch_count_command, NOTMUCH_COMMAND_DATABASE_EARLY,
158 "Count messages matching the search terms." },
159 { "reply", notmuch_reply_command, NOTMUCH_COMMAND_DATABASE_EARLY,
160 "Construct a reply template for a set of messages." },
161 { "tag", notmuch_tag_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
162 "Add/remove tags for all messages matching the search terms." },
163 { "dump", notmuch_dump_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
164 "Create a plain-text dump of the tags for each message." },
165 { "restore", notmuch_restore_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
166 "Restore the tags from the given dump file (see 'dump')." },
167 { "compact", notmuch_compact_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
168 "Compact the notmuch database." },
169 { "reindex", notmuch_reindex_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
170 "Re-index all messages matching the search terms." },
171 { "config", notmuch_config_command, NOTMUCH_COMMAND_CONFIG_OPEN,
172 "Get or set settings in the notmuch configuration file." },
174 { "emacs-mua", NULL, 0,
175 "send mail with notmuch and emacs." },
177 { "help", notmuch_help_command, NOTMUCH_COMMAND_CONFIG_CREATE, /* create but don't save config */
178 "This message, or more detailed help for the named command." }
181 typedef struct help_topic {
186 static help_topic_t help_topics[] = {
188 "Common search term syntax." },
190 "Hooks that will be run before or after certain commands." },
192 "Message property conventions and documentation." },
196 find_command (const char *name)
200 for (i = 0; i < ARRAY_SIZE (commands); i++)
201 if ((! name && ! commands[i].name) ||
202 (name && commands[i].name && strcmp (name, commands[i].name) == 0))
208 int notmuch_format_version;
218 "Usage: notmuch --help\n"
219 " notmuch --version\n"
220 " notmuch <command> [args...]\n");
222 fprintf (out, "The available commands are as follows:\n");
225 for (i = 0; i < ARRAY_SIZE (commands); i++) {
226 command = &commands[i];
229 fprintf (out, " %-12s %s\n", command->name, command->summary);
233 fprintf (out, "Additional help topics are as follows:\n");
236 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
237 topic = &help_topics[i];
238 fprintf (out, " %-12s %s\n", topic->name, topic->summary);
243 "Use \"notmuch help <command or topic>\" for more details "
244 "on each command or topic.\n\n");
248 notmuch_exit_if_unsupported_format (void)
250 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
252 A caller requested output format version %d, but the installed notmuch\n\
253 CLI only supports up to format version %d. You may need to upgrade your\n\
255 notmuch_format_version, NOTMUCH_FORMAT_CUR);
256 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
257 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
259 A caller requested output format version %d, which is no longer supported\n\
260 by the notmuch CLI (it requires at least version %d). You may need to\n\
261 upgrade your notmuch front-end.\n",
262 notmuch_format_version, NOTMUCH_FORMAT_MIN);
263 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
264 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
265 /* Warn about old version requests so compatibility issues are
266 * less likely when we drop support for a deprecated format
269 A caller requested deprecated output format version %d, which may not\n\
270 be supported in the future.\n", notmuch_format_version);
275 notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
277 const char *uuid = NULL;
279 if (! notmuch_requested_db_uuid)
281 IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));
283 if (strcmp (notmuch_requested_db_uuid, uuid) != 0) {
284 fprintf (stderr, "Error: requested database revision %s does not match %s\n",
285 notmuch_requested_db_uuid, uuid);
291 exec_man (const char *page)
293 if (execlp ("man", "man", page, (char *) NULL)) {
300 _help_for (const char *topic_name)
307 printf ("The notmuch mail system.\n\n");
312 if (strcmp (topic_name, "help") == 0) {
313 printf ("The notmuch help system.\n\n"
314 "\tNotmuch uses the man command to display help. In case\n"
315 "\tof difficulties check that MANPATH includes the pages\n"
316 "\tinstalled by notmuch.\n\n"
317 "\tTry \"notmuch help\" for a list of topics.\n");
321 command = find_command (topic_name);
323 char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
327 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
328 topic = &help_topics[i];
329 if (strcmp (topic_name, topic->name) == 0) {
330 char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);
336 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
342 notmuch_help_command (unused (notmuch_config_t *config), unused(notmuch_database_t *notmuch), int argc, char *argv[])
346 opt_index = notmuch_minimal_options ("help", argc, argv);
350 /* skip at least subcommand argument */
355 return _help_for (NULL);
358 return _help_for (argv[0]);
361 /* Handle the case of "notmuch" being invoked with no command
362 * argument. For now we just call notmuch_setup_command, but we plan
363 * to be more clever about this in the future.
366 notmuch_command (notmuch_config_t *config,
367 unused(notmuch_database_t *notmuch),
368 unused(int argc), unused(char **argv))
373 /* If the user has never configured notmuch, then run
374 * notmuch_setup_command which will give a nice welcome message,
375 * and interactively guide the user through the configuration. */
376 if (notmuch_config_is_new (config))
377 return notmuch_setup_command (config, NULL, 0, NULL);
379 /* Notmuch is already configured, but is there a database? */
380 db_path = talloc_asprintf (config, "%s/%s",
381 notmuch_config_get_database_path (config),
383 if (stat (db_path, &st)) {
384 if (errno != ENOENT) {
385 fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
386 db_path, strerror (errno));
389 printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
391 printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
392 "Note that the first run of \"notmuch new\" can take a very long time\n"
393 "and that the resulting database will use roughly the same amount of\n"
394 "storage space as the email being indexed.\n\n");
398 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
399 "At this point you can start exploring the functionality of notmuch by\n"
400 "using commands such as:\n\n"
401 "\tnotmuch search tag:inbox\n\n"
402 "\tnotmuch search to:\"%s\"\n\n"
403 "\tnotmuch search from:\"%s\"\n\n"
404 "\tnotmuch search subject:\"my favorite things\"\n\n"
405 "See \"notmuch help search\" for more details.\n\n"
406 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
407 "from a search. Finally, you may want to explore using a more sophisticated\n"
408 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
409 "or any other interface described at https://notmuchmail.org\n\n"
410 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
411 "Have fun, and may your inbox never have much mail.\n\n",
412 notmuch_config_get_user_name (config),
413 notmuch_config_get_user_primary_email (config));
419 * Try to run subcommand in argv[0] as notmuch- prefixed external
420 * command. argv must be NULL terminated (argv passed to main always
423 * Does not return if the external command is found and
424 * executed. Return true if external command is not found. Return
428 try_external_command (char *argv[])
430 char *old_argv0 = argv[0];
433 argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);
436 * This will only return on errors. Not finding an external
437 * command (ENOENT) is not an error from our perspective.
439 execvp (argv[0], argv);
440 if (errno != ENOENT) {
441 fprintf (stderr, "Error: Running external command '%s' failed: %s\n",
442 argv[0], strerror (errno));
446 talloc_free (argv[0]);
453 main (int argc, char *argv[])
457 const char *command_name = NULL;
459 const char *config_file_name = NULL;
460 notmuch_config_t *config = NULL;
461 notmuch_database_t *notmuch = NULL;
465 notmuch_opt_desc_t options[] = {
466 { .opt_string = &config_file_name, .name = "config" },
467 { .opt_inherit = notmuch_shared_options },
471 talloc_enable_null_tracking ();
473 local = talloc_new (NULL);
476 #if ! GLIB_CHECK_VERSION (2, 35, 1)
480 /* Globally default to the current output format version. */
481 notmuch_format_version = NOTMUCH_FORMAT_CUR;
483 opt_index = parse_arguments (argc, argv, options, 1);
489 if (opt_index < argc)
490 command_name = argv[opt_index];
492 notmuch_process_shared_options (command_name);
494 command = find_command (command_name);
495 /* if command->function is NULL, try external command */
496 if (! command || ! command->function) {
497 /* This won't return if the external command is found. */
498 if (try_external_command (argv + opt_index))
499 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
505 if (command->mode & NOTMUCH_COMMAND_DATABASE_EARLY) {
506 char *status_string = NULL;
507 notmuch_database_mode_t mode;
508 notmuch_status_t status;
510 if (command->mode & NOTMUCH_COMMAND_DATABASE_WRITE ||
511 command->mode & NOTMUCH_COMMAND_DATABASE_CREATE)
512 mode = NOTMUCH_DATABASE_MODE_READ_WRITE;
514 mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
516 if (command->mode & NOTMUCH_COMMAND_DATABASE_CREATE) {
517 status = notmuch_database_create_with_config (NULL,
522 if (status && status != NOTMUCH_STATUS_DATABASE_EXISTS) {
524 fputs (status_string, stderr);
525 free (status_string);
528 if (status == NOTMUCH_STATUS_NO_CONFIG)
529 fputs ("Try running 'notmuch setup' to create a configuration.", stderr);
535 if (notmuch == NULL) {
536 status = notmuch_database_open_with_config (NULL,
544 fputs (status_string, stderr);
545 free (status_string);
552 config = notmuch_config_open (local, config_file_name, command->mode);
558 ret = (command->function)(config, notmuch, argc - opt_index, argv + opt_index);
562 notmuch_config_close (config);
564 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
565 if (talloc_report && strcmp (talloc_report, "") != 0) {
566 /* this relies on the previous call to
567 * talloc_enable_null_tracking
570 FILE *report = fopen (talloc_report, "w");
572 talloc_report_full (NULL, report);
575 fprintf (stderr, "ERROR: unable to write talloc log. ");
576 perror (talloc_report);