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);
53 notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch);
55 static bool print_version = false, print_help = false;
56 static const char *notmuch_requested_db_uuid = NULL;
57 static int query_syntax = NOTMUCH_QUERY_SYNTAX_XAPIAN;
59 const notmuch_opt_desc_t notmuch_shared_options [] = {
60 { .opt_bool = &print_version, .name = "version" },
61 { .opt_bool = &print_help, .name = "help" },
62 { .opt_string = ¬much_requested_db_uuid, .name = "uuid" },
63 { .opt_keyword = &query_syntax, .name = "query", .keywords =
64 (notmuch_keyword_t []){ { "infix", NOTMUCH_QUERY_SYNTAX_XAPIAN },
65 { "sexp", NOTMUCH_QUERY_SYNTAX_SEXP },
71 notmuch_query_syntax_t
72 shared_option_query_syntax ()
77 /* any subcommand wanting to support these options should call
78 * inherit notmuch_shared_options and call
79 * notmuch_process_shared_options (notmuch, subcommand_name);
80 * with notmuch = an open database, or NULL.
83 notmuch_process_shared_options (notmuch_database_t *notmuch, const char *subcommand_name)
86 printf ("notmuch " STRINGIFY (NOTMUCH_VERSION) "\n");
91 int ret = _help_for (subcommand_name);
96 notmuch_exit_if_unmatched_db_uuid (notmuch);
98 if (notmuch_requested_db_uuid)
99 fprintf (stderr, "Warning: ignoring --uuid=%s\n",
100 notmuch_requested_db_uuid);
104 /* This is suitable for subcommands that do not actually open the
108 notmuch_minimal_options (const char *subcommand_name,
109 int argc, char **argv)
113 notmuch_opt_desc_t options[] = {
114 { .opt_inherit = notmuch_shared_options },
118 opt_index = parse_arguments (argc, argv, options, 1);
123 /* We can't use argv here as it is sometimes NULL */
124 notmuch_process_shared_options (NULL, subcommand_name);
129 struct _notmuch_client_indexing_cli_choices indexing_cli_choices = { };
130 const notmuch_opt_desc_t notmuch_shared_indexing_options [] = {
131 { .opt_keyword = &indexing_cli_choices.decrypt_policy,
132 .present = &indexing_cli_choices.decrypt_policy_set, .keywords =
133 (notmuch_keyword_t []){ { "false", NOTMUCH_DECRYPT_FALSE },
134 { "true", NOTMUCH_DECRYPT_TRUE },
135 { "auto", NOTMUCH_DECRYPT_AUTO },
136 { "nostash", NOTMUCH_DECRYPT_NOSTASH },
144 notmuch_process_shared_indexing_options (notmuch_indexopts_t *opts)
147 return NOTMUCH_STATUS_NULL_POINTER;
149 if (indexing_cli_choices.decrypt_policy_set) {
150 notmuch_status_t status;
151 status = notmuch_indexopts_set_decrypt_policy (opts,
152 indexing_cli_choices.decrypt_policy);
153 if (status != NOTMUCH_STATUS_SUCCESS) {
154 fprintf (stderr, "Error: Failed to set index decryption policy to %d. (%s)\n",
155 indexing_cli_choices.decrypt_policy, notmuch_status_to_string (status));
159 return NOTMUCH_STATUS_SUCCESS;
163 static const command_t commands[] = {
164 { NULL, notmuch_command, NOTMUCH_COMMAND_CONFIG_CREATE | NOTMUCH_COMMAND_CONFIG_LOAD,
165 "Notmuch main command." },
166 { "setup", notmuch_setup_command, NOTMUCH_COMMAND_CONFIG_CREATE | NOTMUCH_COMMAND_CONFIG_LOAD,
167 "Interactively set up notmuch for first use." },
168 { "new", notmuch_new_command,
169 NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE |
170 NOTMUCH_COMMAND_DATABASE_CREATE,
171 "Find and import new messages to the notmuch database." },
172 { "insert", notmuch_insert_command, NOTMUCH_COMMAND_DATABASE_EARLY |
173 NOTMUCH_COMMAND_DATABASE_WRITE,
174 "Add a new message into the maildir and notmuch database." },
175 { "search", notmuch_search_command, NOTMUCH_COMMAND_DATABASE_EARLY,
176 "Search for messages matching the given search terms." },
177 { "address", notmuch_address_command, NOTMUCH_COMMAND_DATABASE_EARLY,
178 "Get addresses from messages matching the given search terms." },
179 { "show", notmuch_show_command, NOTMUCH_COMMAND_DATABASE_EARLY,
180 "Show all messages matching the search terms." },
181 { "count", notmuch_count_command, NOTMUCH_COMMAND_DATABASE_EARLY,
182 "Count messages matching the search terms." },
183 { "reply", notmuch_reply_command, NOTMUCH_COMMAND_DATABASE_EARLY,
184 "Construct a reply template for a set of messages." },
185 { "tag", notmuch_tag_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
186 "Add/remove tags for all messages matching the search terms." },
187 { "dump", notmuch_dump_command, NOTMUCH_COMMAND_DATABASE_EARLY | NOTMUCH_COMMAND_DATABASE_WRITE,
188 "Create a plain-text dump of the tags for each message." },
189 { "restore", notmuch_restore_command, NOTMUCH_COMMAND_DATABASE_EARLY |
190 NOTMUCH_COMMAND_DATABASE_WRITE,
191 "Restore the tags from the given dump file (see 'dump')." },
192 { "compact", notmuch_compact_command, NOTMUCH_COMMAND_DATABASE_EARLY |
193 NOTMUCH_COMMAND_DATABASE_WRITE,
194 "Compact the notmuch database." },
195 { "reindex", notmuch_reindex_command, NOTMUCH_COMMAND_DATABASE_EARLY |
196 NOTMUCH_COMMAND_DATABASE_WRITE,
197 "Re-index all messages matching the search terms." },
198 { "config", notmuch_config_command, NOTMUCH_COMMAND_CONFIG_LOAD,
199 "Get or set settings in the notmuch configuration file." },
201 { "emacs-mua", NULL, 0,
202 "send mail with notmuch and emacs." },
204 { "help", notmuch_help_command, NOTMUCH_COMMAND_CONFIG_CREATE, /* create but don't save config */
205 "This message, or more detailed help for the named command." }
208 typedef struct help_topic {
213 static const help_topic_t help_topics[] = {
215 "Common search term syntax." },
217 "Hooks that will be run before or after certain commands." },
219 "Message property conventions and documentation." },
222 static const command_t *
223 find_command (const char *name)
227 for (i = 0; i < ARRAY_SIZE (commands); i++)
228 if ((! name && ! commands[i].name) ||
229 (name && commands[i].name && strcmp (name, commands[i].name) == 0))
235 int notmuch_format_version;
240 const command_t *command;
241 const help_topic_t *topic;
245 "Usage: notmuch --help\n"
246 " notmuch --version\n"
247 " notmuch <command> [args...]\n");
249 fprintf (out, "The available commands are as follows:\n");
252 for (i = 0; i < ARRAY_SIZE (commands); i++) {
253 command = &commands[i];
256 fprintf (out, " %-12s %s\n", command->name, command->summary);
260 fprintf (out, "Additional help topics are as follows:\n");
263 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
264 topic = &help_topics[i];
265 fprintf (out, " %-12s %s\n", topic->name, topic->summary);
270 "Use \"notmuch help <command or topic>\" for more details "
271 "on each command or topic.\n\n");
275 notmuch_exit_if_unsupported_format (void)
277 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
280 A caller requested output format version %d, but the installed notmuch\n\
281 CLI only supports up to format version %d. You may need to upgrade your\n\
283 notmuch_format_version, NOTMUCH_FORMAT_CUR);
284 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
285 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
288 A caller requested output format version %d, which is no longer supported\n\
289 by the notmuch CLI (it requires at least version %d). You may need to\n\
290 upgrade your notmuch front-end.\n",
291 notmuch_format_version, NOTMUCH_FORMAT_MIN);
292 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
293 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
294 /* Warn about old version requests so compatibility issues are
295 * less likely when we drop support for a deprecated format
299 A caller requested deprecated output format version %d, which may not\n\
300 be supported in the future.\n", notmuch_format_version);
305 notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
307 const char *uuid = NULL;
309 if (! notmuch_requested_db_uuid)
311 IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));
313 if (strcmp (notmuch_requested_db_uuid, uuid) != 0) {
314 fprintf (stderr, "Error: requested database revision %s does not match %s\n",
315 notmuch_requested_db_uuid, uuid);
321 exec_man (const char *page)
323 if (execlp ("man", "man", page, (char *) NULL)) {
330 _help_for (const char *topic_name)
335 printf ("The notmuch mail system.\n\n");
340 if (strcmp (topic_name, "help") == 0) {
341 printf ("The notmuch help system.\n\n"
342 "\tNotmuch uses the man command to display help. In case\n"
343 "\tof difficulties check that MANPATH includes the pages\n"
344 "\tinstalled by notmuch.\n\n"
345 "\tTry \"notmuch help\" for a list of topics.\n");
349 page = talloc_asprintf (NULL, "notmuch-%s", topic_name);
356 notmuch_help_command (unused(notmuch_database_t *notmuch), int argc, char *argv[])
360 opt_index = notmuch_minimal_options ("help", argc, argv);
364 /* skip at least subcommand argument */
369 return _help_for (NULL);
372 return _help_for (argv[0]);
375 /* Handle the case of "notmuch" being invoked with no command
376 * argument. For now we just call notmuch_setup_command, but we plan
377 * to be more clever about this in the future.
380 notmuch_command (notmuch_database_t *notmuch,
381 unused(int argc), unused(char **argv))
384 const char *config_path;
386 /* If the user has not created a configuration file, then run
387 * notmuch_setup_command which will give a nice welcome message,
388 * and interactively guide the user through the configuration. */
389 config_path = notmuch_config_path (notmuch);
390 if (access (config_path, R_OK | F_OK) == -1) {
391 if (errno != ENOENT) {
392 fprintf (stderr, "Error: %s config file access failed: %s\n", config_path,
396 return notmuch_setup_command (notmuch, 0, NULL);
400 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
401 "At this point you can start exploring the functionality of notmuch by\n"
402 "using commands such as:\n\n"
403 "\tnotmuch search tag:inbox\n\n"
404 "\tnotmuch search to:\"%s\"\n\n"
405 "\tnotmuch search from:\"%s\"\n\n"
406 "\tnotmuch search subject:\"my favorite things\"\n\n"
407 "See \"notmuch help search\" for more details.\n\n"
408 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
409 "from a search. Finally, you may want to explore using a more sophisticated\n"
410 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
411 "or any other interface described at https://notmuchmail.org\n\n"
412 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
413 "Have fun, and may your inbox never have much mail.\n\n",
414 notmuch_config_get (notmuch, NOTMUCH_CONFIG_USER_NAME),
415 notmuch_config_get (notmuch, NOTMUCH_CONFIG_PRIMARY_EMAIL));
421 * Try to run subcommand in argv[0] as notmuch- prefixed external
422 * command. argv must be NULL terminated (argv passed to main always
425 * Does not return if the external command is found and
426 * executed. Return true if external command is not found. Return
430 try_external_command (char *argv[])
432 char *old_argv0 = argv[0];
435 argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);
438 * This will only return on errors. Not finding an external
439 * command (ENOENT) is not an error from our perspective.
441 execvp (argv[0], argv);
442 if (errno != ENOENT) {
443 fprintf (stderr, "Error: Running external command '%s' failed: %s\n",
444 argv[0], strerror (errno));
448 talloc_free (argv[0]);
455 main (int argc, char *argv[])
459 const char *command_name = NULL;
460 const command_t *command;
461 const char *config_file_name = NULL;
462 notmuch_database_t *notmuch = NULL;
464 int ret = EXIT_SUCCESS;
466 notmuch_opt_desc_t options[] = {
467 { .opt_string = &config_file_name, .name = "config", .allow_empty = TRUE },
468 { .opt_inherit = notmuch_shared_options },
472 notmuch_client_init ();
474 local = talloc_new (NULL);
476 /* Globally default to the current output format version. */
477 notmuch_format_version = NOTMUCH_FORMAT_CUR;
479 opt_index = parse_arguments (argc, argv, options, 1);
485 if (opt_index < argc)
486 command_name = argv[opt_index];
488 notmuch_process_shared_options (NULL, command_name);
490 command = find_command (command_name);
491 /* if command->function is NULL, try external command */
492 if (! command || ! command->function) {
493 /* This won't return if the external command is found. */
494 if (try_external_command (argv + opt_index))
495 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
501 if (command->mode & NOTMUCH_COMMAND_DATABASE_EARLY) {
502 char *status_string = NULL;
503 notmuch_database_mode_t mode;
504 notmuch_status_t status;
506 if (command->mode & NOTMUCH_COMMAND_DATABASE_WRITE ||
507 command->mode & NOTMUCH_COMMAND_DATABASE_CREATE)
508 mode = NOTMUCH_DATABASE_MODE_READ_WRITE;
510 mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
512 if (command->mode & NOTMUCH_COMMAND_DATABASE_CREATE) {
513 status = notmuch_database_create_with_config (NULL,
518 if (status && status != NOTMUCH_STATUS_DATABASE_EXISTS) {
520 fputs (status_string, stderr);
521 free (status_string);
524 if (status == NOTMUCH_STATUS_NO_CONFIG)
525 fputs ("Try running 'notmuch setup' to create a configuration.", stderr);
531 if (notmuch == NULL) {
532 status = notmuch_database_open_with_config (NULL,
540 fputs (status_string, stderr);
541 free (status_string);
549 if (command->mode & NOTMUCH_COMMAND_CONFIG_LOAD) {
550 char *status_string = NULL;
551 notmuch_status_t status;
552 status = notmuch_database_load_config (NULL,
558 if (status == NOTMUCH_STATUS_NO_CONFIG && ! (command->mode & NOTMUCH_COMMAND_CONFIG_CREATE)) {
559 fputs ("Try running 'notmuch setup' to create a configuration.", stderr);
563 case NOTMUCH_STATUS_NO_CONFIG:
564 if (! (command->mode & NOTMUCH_COMMAND_CONFIG_CREATE)) {
565 fputs ("Try running 'notmuch setup' to create a configuration.", stderr);
569 case NOTMUCH_STATUS_NO_DATABASE:
570 if (! command_name) {
571 printf ("Notmuch is configured, but no database was found.\n");
572 printf ("You probably want to run \"notmuch new\" now to create a database.\n\n"
573 "Note that the first run of \"notmuch new\" can take a very long time\n"
574 "and that the resulting database will use roughly the same amount of\n"
575 "storage space as the email being indexed.\n\n");
576 status = NOTMUCH_STATUS_SUCCESS;
580 case NOTMUCH_STATUS_SUCCESS:
588 ret = (command->function)(notmuch, argc - opt_index, argv + opt_index);
591 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
592 if (talloc_report && strcmp (talloc_report, "") != 0) {
593 /* this relies on the previous call to
594 * talloc_enable_null_tracking
597 FILE *report = fopen (talloc_report, "a");
599 talloc_report_full (NULL, report);
602 fprintf (stderr, "ERROR: unable to write talloc log. ");
603 perror (talloc_report);