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 main command." },
146 { "setup", notmuch_setup_command, NOTMUCH_COMMAND_CONFIG_OPEN | NOTMUCH_COMMAND_CONFIG_CREATE,
147 "Interactively set up notmuch for first use." },
148 { "new", notmuch_new_command,
149 NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE |
150 NOTMUCH_COMMAND_DATABASE_CREATE,
151 "Find and import new messages to the notmuch database." },
152 { "insert", notmuch_insert_command, NOTMUCH_COMMAND_DATABASE_EARLY |
153 NOTMUCH_COMMAND_DATABASE_WRITE,
154 "Add a new message into the maildir and notmuch database." },
155 { "search", notmuch_search_command, NOTMUCH_COMMAND_DATABASE_EARLY,
156 "Search for messages matching the given search terms." },
157 { "address", notmuch_address_command, NOTMUCH_COMMAND_DATABASE_EARLY,
158 "Get addresses from messages matching the given search terms." },
159 { "show", notmuch_show_command, NOTMUCH_COMMAND_DATABASE_EARLY,
160 "Show all messages matching the search terms." },
161 { "count", notmuch_count_command, NOTMUCH_COMMAND_DATABASE_EARLY,
162 "Count messages matching the search terms." },
163 { "reply", notmuch_reply_command, NOTMUCH_COMMAND_DATABASE_EARLY,
164 "Construct a reply template for a set of messages." },
165 { "tag", notmuch_tag_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
166 "Add/remove tags for all messages matching the search terms." },
167 { "dump", notmuch_dump_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
168 "Create a plain-text dump of the tags for each message." },
169 { "restore", notmuch_restore_command, NOTMUCH_COMMAND_DATABASE_EARLY |
170 NOTMUCH_COMMAND_DATABASE_WRITE,
171 "Restore the tags from the given dump file (see 'dump')." },
172 { "compact", notmuch_compact_command, NOTMUCH_COMMAND_DATABASE_EARLY |
173 NOTMUCH_COMMAND_DATABASE_WRITE,
174 "Compact the notmuch database." },
175 { "reindex", notmuch_reindex_command, NOTMUCH_COMMAND_DATABASE_EARLY |
176 NOTMUCH_COMMAND_DATABASE_WRITE,
177 "Re-index all messages matching the search terms." },
178 { "config", notmuch_config_command, NOTMUCH_COMMAND_CONFIG_OPEN | NOTMUCH_COMMAND_CONFIG_LOAD,
179 "Get or set settings in the notmuch configuration file." },
181 { "emacs-mua", NULL, 0,
182 "send mail with notmuch and emacs." },
184 { "help", notmuch_help_command, NOTMUCH_COMMAND_CONFIG_CREATE, /* create but don't save config */
185 "This message, or more detailed help for the named command." }
188 typedef struct help_topic {
193 static help_topic_t help_topics[] = {
195 "Common search term syntax." },
197 "Hooks that will be run before or after certain commands." },
199 "Message property conventions and documentation." },
203 find_command (const char *name)
207 for (i = 0; i < ARRAY_SIZE (commands); i++)
208 if ((! name && ! commands[i].name) ||
209 (name && commands[i].name && strcmp (name, commands[i].name) == 0))
215 int notmuch_format_version;
225 "Usage: notmuch --help\n"
226 " notmuch --version\n"
227 " notmuch <command> [args...]\n");
229 fprintf (out, "The available commands are as follows:\n");
232 for (i = 0; i < ARRAY_SIZE (commands); i++) {
233 command = &commands[i];
236 fprintf (out, " %-12s %s\n", command->name, command->summary);
240 fprintf (out, "Additional help topics are as follows:\n");
243 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
244 topic = &help_topics[i];
245 fprintf (out, " %-12s %s\n", topic->name, topic->summary);
250 "Use \"notmuch help <command or topic>\" for more details "
251 "on each command or topic.\n\n");
255 notmuch_exit_if_unsupported_format (void)
257 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
260 A caller requested output format version %d, but the installed notmuch\n\
261 CLI only supports up to format version %d. You may need to upgrade your\n\
263 notmuch_format_version, NOTMUCH_FORMAT_CUR);
264 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
265 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
268 A caller requested output format version %d, which is no longer supported\n\
269 by the notmuch CLI (it requires at least version %d). You may need to\n\
270 upgrade your notmuch front-end.\n",
271 notmuch_format_version, NOTMUCH_FORMAT_MIN);
272 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
273 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
274 /* Warn about old version requests so compatibility issues are
275 * less likely when we drop support for a deprecated format
279 A caller requested deprecated output format version %d, which may not\n\
280 be supported in the future.\n", notmuch_format_version);
285 notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
287 const char *uuid = NULL;
289 if (! notmuch_requested_db_uuid)
291 IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));
293 if (strcmp (notmuch_requested_db_uuid, uuid) != 0) {
294 fprintf (stderr, "Error: requested database revision %s does not match %s\n",
295 notmuch_requested_db_uuid, uuid);
301 exec_man (const char *page)
303 if (execlp ("man", "man", page, (char *) NULL)) {
310 _help_for (const char *topic_name)
317 printf ("The notmuch mail system.\n\n");
322 if (strcmp (topic_name, "help") == 0) {
323 printf ("The notmuch help system.\n\n"
324 "\tNotmuch uses the man command to display help. In case\n"
325 "\tof difficulties check that MANPATH includes the pages\n"
326 "\tinstalled by notmuch.\n\n"
327 "\tTry \"notmuch help\" for a list of topics.\n");
331 command = find_command (topic_name);
333 char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
337 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
338 topic = &help_topics[i];
339 if (strcmp (topic_name, topic->name) == 0) {
340 char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);
346 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
352 notmuch_help_command (unused (notmuch_config_t *config), unused(notmuch_database_t *notmuch), int
357 opt_index = notmuch_minimal_options ("help", argc, argv);
361 /* skip at least subcommand argument */
366 return _help_for (NULL);
369 return _help_for (argv[0]);
372 /* Handle the case of "notmuch" being invoked with no command
373 * argument. For now we just call notmuch_setup_command, but we plan
374 * to be more clever about this in the future.
377 notmuch_command (notmuch_config_t *config,
378 unused(notmuch_database_t *notmuch),
379 unused(int argc), unused(char **argv))
384 /* If the user has never configured notmuch, then run
385 * notmuch_setup_command which will give a nice welcome message,
386 * and interactively guide the user through the configuration. */
387 if (notmuch_config_is_new (config))
388 return notmuch_setup_command (config, NULL, 0, NULL);
390 /* Notmuch is already configured, but is there a database? */
391 db_path = talloc_asprintf (config, "%s/%s",
392 notmuch_config_get_database_path (config),
394 if (stat (db_path, &st)) {
395 if (errno != ENOENT) {
396 fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
397 db_path, strerror (errno));
400 printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
402 printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
403 "Note that the first run of \"notmuch new\" can take a very long time\n"
404 "and that the resulting database will use roughly the same amount of\n"
405 "storage space as the email being indexed.\n\n");
409 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
410 "At this point you can start exploring the functionality of notmuch by\n"
411 "using commands such as:\n\n"
412 "\tnotmuch search tag:inbox\n\n"
413 "\tnotmuch search to:\"%s\"\n\n"
414 "\tnotmuch search from:\"%s\"\n\n"
415 "\tnotmuch search subject:\"my favorite things\"\n\n"
416 "See \"notmuch help search\" for more details.\n\n"
417 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
418 "from a search. Finally, you may want to explore using a more sophisticated\n"
419 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
420 "or any other interface described at https://notmuchmail.org\n\n"
421 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
422 "Have fun, and may your inbox never have much mail.\n\n",
423 notmuch_config_get_user_name (config),
424 notmuch_config_get_user_primary_email (config));
430 * Try to run subcommand in argv[0] as notmuch- prefixed external
431 * command. argv must be NULL terminated (argv passed to main always
434 * Does not return if the external command is found and
435 * executed. Return true if external command is not found. Return
439 try_external_command (char *argv[])
441 char *old_argv0 = argv[0];
444 argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);
447 * This will only return on errors. Not finding an external
448 * command (ENOENT) is not an error from our perspective.
450 execvp (argv[0], argv);
451 if (errno != ENOENT) {
452 fprintf (stderr, "Error: Running external command '%s' failed: %s\n",
453 argv[0], strerror (errno));
457 talloc_free (argv[0]);
464 main (int argc, char *argv[])
468 const char *command_name = NULL;
470 const char *config_file_name = NULL;
471 notmuch_config_t *config = NULL;
472 notmuch_database_t *notmuch = NULL;
474 int ret = EXIT_SUCCESS;
476 notmuch_opt_desc_t options[] = {
477 { .opt_string = &config_file_name, .name = "config" },
478 { .opt_inherit = notmuch_shared_options },
482 talloc_enable_null_tracking ();
484 local = talloc_new (NULL);
487 #if ! GLIB_CHECK_VERSION (2, 35, 1)
491 /* Globally default to the current output format version. */
492 notmuch_format_version = NOTMUCH_FORMAT_CUR;
494 opt_index = parse_arguments (argc, argv, options, 1);
500 if (opt_index < argc)
501 command_name = argv[opt_index];
503 notmuch_process_shared_options (command_name);
505 command = find_command (command_name);
506 /* if command->function is NULL, try external command */
507 if (! command || ! command->function) {
508 /* This won't return if the external command is found. */
509 if (try_external_command (argv + opt_index))
510 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
516 if (command->mode & NOTMUCH_COMMAND_DATABASE_EARLY) {
517 char *status_string = NULL;
518 notmuch_database_mode_t mode;
519 notmuch_status_t status;
521 if (command->mode & NOTMUCH_COMMAND_DATABASE_WRITE ||
522 command->mode & NOTMUCH_COMMAND_DATABASE_CREATE)
523 mode = NOTMUCH_DATABASE_MODE_READ_WRITE;
525 mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
527 if (command->mode & NOTMUCH_COMMAND_DATABASE_CREATE) {
528 status = notmuch_database_create_with_config (NULL,
533 if (status && status != NOTMUCH_STATUS_DATABASE_EXISTS) {
535 fputs (status_string, stderr);
536 free (status_string);
539 if (status == NOTMUCH_STATUS_NO_CONFIG)
540 fputs ("Try running 'notmuch setup' to create a configuration.", stderr);
546 if (notmuch == NULL) {
547 status = notmuch_database_open_with_config (NULL,
555 fputs (status_string, stderr);
556 free (status_string);
564 if (command->mode & NOTMUCH_COMMAND_CONFIG_LOAD) {
565 char *status_string = NULL;
566 notmuch_status_t status;
567 status = notmuch_database_load_config (NULL,
574 fputs (status_string, stderr);
575 free (status_string);
578 if (status == NOTMUCH_STATUS_NO_CONFIG)
579 fputs ("Try running 'notmuch setup' to create a configuration.", stderr);
585 if (command->mode & NOTMUCH_COMMAND_CONFIG_OPEN) {
586 config = notmuch_config_open (local, config_file_name, command->mode);
592 ret = (command->function)(config, notmuch, argc - opt_index, argv + opt_index);
596 notmuch_config_close (config);
598 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
599 if (talloc_report && strcmp (talloc_report, "") != 0) {
600 /* this relies on the previous call to
601 * talloc_enable_null_tracking
604 FILE *report = fopen (talloc_report, "w");
606 talloc_report_full (NULL, report);
609 fprintf (stderr, "ERROR: unable to write talloc log. ");
610 perror (talloc_report);