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 * preferrably EXIT_SUCCESS or EXIT_FAILURE.
31 typedef int (*command_function_t) (notmuch_config_t *config, int argc, char *argv[]);
33 typedef struct command {
35 command_function_t function;
36 notmuch_config_mode_t config_mode;
41 notmuch_help_command (notmuch_config_t *config, int argc, char *argv[]);
44 notmuch_command (notmuch_config_t *config, int argc, char *argv[]);
47 _help_for (const char *topic);
49 static bool print_version = false, print_help = false;
50 const char *notmuch_requested_db_uuid = NULL;
52 const notmuch_opt_desc_t notmuch_shared_options [] = {
53 { .opt_bool = &print_version, .name = "version" },
54 { .opt_bool = &print_help, .name = "help" },
55 { .opt_string = ¬much_requested_db_uuid, .name = "uuid" },
59 /* any subcommand wanting to support these options should call
60 * inherit notmuch_shared_options and call
61 * notmuch_process_shared_options (subcommand_name);
64 notmuch_process_shared_options (const char *subcommand_name) {
66 printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
71 int ret = _help_for (subcommand_name);
76 /* This is suitable for subcommands that do not actually open the
79 int notmuch_minimal_options (const char *subcommand_name,
80 int argc, char **argv)
84 notmuch_opt_desc_t options[] = {
85 { .opt_inherit = notmuch_shared_options },
89 opt_index = parse_arguments (argc, argv, options, 1);
94 /* We can't use argv here as it is sometimes NULL */
95 notmuch_process_shared_options (subcommand_name);
100 struct _notmuch_client_indexing_cli_choices indexing_cli_choices = { };
101 const notmuch_opt_desc_t notmuch_shared_indexing_options [] = {
102 { .opt_bool = &indexing_cli_choices.try_decrypt,
103 .present = &indexing_cli_choices.try_decrypt_set,
104 .name = "try-decrypt" },
110 notmuch_process_shared_indexing_options (notmuch_database_t *notmuch, g_mime_3_unused(notmuch_config_t *config))
112 if (indexing_cli_choices.opts == NULL)
113 indexing_cli_choices.opts = notmuch_database_get_default_indexopts (notmuch);
114 if (indexing_cli_choices.try_decrypt_set) {
115 notmuch_status_t status;
116 if (indexing_cli_choices.opts == NULL)
117 return NOTMUCH_STATUS_OUT_OF_MEMORY;
118 status = notmuch_indexopts_set_try_decrypt (indexing_cli_choices.opts, indexing_cli_choices.try_decrypt);
119 if (status != NOTMUCH_STATUS_SUCCESS) {
120 fprintf (stderr, "Error: Failed to set try_decrypt to %s. (%s)\n",
121 indexing_cli_choices.try_decrypt ? "True" : "False", notmuch_status_to_string (status));
122 notmuch_indexopts_destroy (indexing_cli_choices.opts);
123 indexing_cli_choices.opts = NULL;
127 #if (GMIME_MAJOR_VERSION < 3)
128 if (indexing_cli_choices.opts && notmuch_indexopts_get_try_decrypt (indexing_cli_choices.opts)) {
129 const char* gpg_path = notmuch_config_get_crypto_gpg_path (config);
130 if (gpg_path && strcmp(gpg_path, "gpg"))
131 fprintf (stderr, "Warning: deprecated crypto.gpg_path is set to '%s'\n"
132 "\tbut ignoring (use $PATH instead)\n", gpg_path);
135 return NOTMUCH_STATUS_SUCCESS;
139 static command_t commands[] = {
140 { NULL, notmuch_command, NOTMUCH_CONFIG_OPEN | NOTMUCH_CONFIG_CREATE,
141 "Notmuch main command." },
142 { "setup", notmuch_setup_command, NOTMUCH_CONFIG_OPEN | NOTMUCH_CONFIG_CREATE,
143 "Interactively set up notmuch for first use." },
144 { "new", notmuch_new_command, NOTMUCH_CONFIG_OPEN,
145 "Find and import new messages to the notmuch database." },
146 { "insert", notmuch_insert_command, NOTMUCH_CONFIG_OPEN,
147 "Add a new message into the maildir and notmuch database." },
148 { "search", notmuch_search_command, NOTMUCH_CONFIG_OPEN,
149 "Search for messages matching the given search terms." },
150 { "address", notmuch_address_command, NOTMUCH_CONFIG_OPEN,
151 "Get addresses from messages matching the given search terms." },
152 { "show", notmuch_show_command, NOTMUCH_CONFIG_OPEN,
153 "Show all messages matching the search terms." },
154 { "count", notmuch_count_command, NOTMUCH_CONFIG_OPEN,
155 "Count messages matching the search terms." },
156 { "reply", notmuch_reply_command, NOTMUCH_CONFIG_OPEN,
157 "Construct a reply template for a set of messages." },
158 { "tag", notmuch_tag_command, NOTMUCH_CONFIG_OPEN,
159 "Add/remove tags for all messages matching the search terms." },
160 { "dump", notmuch_dump_command, NOTMUCH_CONFIG_OPEN,
161 "Create a plain-text dump of the tags for each message." },
162 { "restore", notmuch_restore_command, NOTMUCH_CONFIG_OPEN,
163 "Restore the tags from the given dump file (see 'dump')." },
164 { "compact", notmuch_compact_command, NOTMUCH_CONFIG_OPEN,
165 "Compact the notmuch database." },
166 { "reindex", notmuch_reindex_command, NOTMUCH_CONFIG_OPEN,
167 "Re-index all messages matching the search terms." },
168 { "config", notmuch_config_command, NOTMUCH_CONFIG_OPEN,
169 "Get or set settings in the notmuch configuration file." },
170 { "help", notmuch_help_command, NOTMUCH_CONFIG_CREATE, /* create but don't save config */
171 "This message, or more detailed help for the named command." }
174 typedef struct help_topic {
179 static help_topic_t help_topics[] = {
181 "Common search term syntax." },
183 "Hooks that will be run before or after certain commands." },
187 find_command (const char *name)
191 for (i = 0; i < ARRAY_SIZE (commands); i++)
192 if ((!name && !commands[i].name) ||
193 (name && commands[i].name && strcmp (name, commands[i].name) == 0))
199 int notmuch_format_version;
209 "Usage: notmuch --help\n"
210 " notmuch --version\n"
211 " notmuch <command> [args...]\n");
213 fprintf (out, "The available commands are as follows:\n");
216 for (i = 0; i < ARRAY_SIZE (commands); i++) {
217 command = &commands[i];
220 fprintf (out, " %-12s %s\n", command->name, command->summary);
224 fprintf (out, "Additional help topics are as follows:\n");
227 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
228 topic = &help_topics[i];
229 fprintf (out, " %-12s %s\n", topic->name, topic->summary);
234 "Use \"notmuch help <command or topic>\" for more details "
235 "on each command or topic.\n\n");
239 notmuch_exit_if_unsupported_format (void)
241 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
243 A caller requested output format version %d, but the installed notmuch\n\
244 CLI only supports up to format version %d. You may need to upgrade your\n\
246 notmuch_format_version, NOTMUCH_FORMAT_CUR);
247 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
248 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
250 A caller requested output format version %d, which is no longer supported\n\
251 by the notmuch CLI (it requires at least version %d). You may need to\n\
252 upgrade your notmuch front-end.\n",
253 notmuch_format_version, NOTMUCH_FORMAT_MIN);
254 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
255 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
256 /* Warn about old version requests so compatibility issues are
257 * less likely when we drop support for a deprecated format
260 A caller requested deprecated output format version %d, which may not\n\
261 be supported in the future.\n", notmuch_format_version);
266 notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
268 const char *uuid = NULL;
270 if (!notmuch_requested_db_uuid)
272 IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));
274 if (strcmp (notmuch_requested_db_uuid, uuid) != 0){
275 fprintf (stderr, "Error: requested database revision %s does not match %s\n",
276 notmuch_requested_db_uuid, uuid);
282 exec_man (const char *page)
284 if (execlp ("man", "man", page, (char *) NULL)) {
291 _help_for (const char *topic_name)
298 printf ("The notmuch mail system.\n\n");
303 if (strcmp (topic_name, "help") == 0) {
304 printf ("The notmuch help system.\n\n"
305 "\tNotmuch uses the man command to display help. In case\n"
306 "\tof difficulties check that MANPATH includes the pages\n"
307 "\tinstalled by notmuch.\n\n"
308 "\tTry \"notmuch help\" for a list of topics.\n");
312 command = find_command (topic_name);
314 char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
318 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
319 topic = &help_topics[i];
320 if (strcmp (topic_name, topic->name) == 0) {
321 char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);
327 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
333 notmuch_help_command (unused (notmuch_config_t * config), int argc, char *argv[])
337 opt_index = notmuch_minimal_options ("help", argc, argv);
341 /* skip at least subcommand argument */
346 return _help_for (NULL);
349 return _help_for (argv[0]);
352 /* Handle the case of "notmuch" being invoked with no command
353 * argument. For now we just call notmuch_setup_command, but we plan
354 * to be more clever about this in the future.
357 notmuch_command (notmuch_config_t *config,
358 unused(int argc), unused(char *argv[]))
363 /* If the user has never configured notmuch, then run
364 * notmuch_setup_command which will give a nice welcome message,
365 * and interactively guide the user through the configuration. */
366 if (notmuch_config_is_new (config))
367 return notmuch_setup_command (config, 0, NULL);
369 /* Notmuch is already configured, but is there a database? */
370 db_path = talloc_asprintf (config, "%s/%s",
371 notmuch_config_get_database_path (config),
373 if (stat (db_path, &st)) {
374 if (errno != ENOENT) {
375 fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
376 db_path, strerror (errno));
379 printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
381 printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
382 "Note that the first run of \"notmuch new\" can take a very long time\n"
383 "and that the resulting database will use roughly the same amount of\n"
384 "storage space as the email being indexed.\n\n");
388 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
389 "At this point you can start exploring the functionality of notmuch by\n"
390 "using commands such as:\n\n"
391 "\tnotmuch search tag:inbox\n\n"
392 "\tnotmuch search to:\"%s\"\n\n"
393 "\tnotmuch search from:\"%s\"\n\n"
394 "\tnotmuch search subject:\"my favorite things\"\n\n"
395 "See \"notmuch help search\" for more details.\n\n"
396 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
397 "from a search. Finally, you may want to explore using a more sophisticated\n"
398 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
399 "or any other interface described at https://notmuchmail.org\n\n"
400 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
401 "Have fun, and may your inbox never have much mail.\n\n",
402 notmuch_config_get_user_name (config),
403 notmuch_config_get_user_primary_email (config));
409 * Try to run subcommand in argv[0] as notmuch- prefixed external
410 * command. argv must be NULL terminated (argv passed to main always
413 * Does not return if the external command is found and
414 * executed. Return true if external command is not found. Return
417 static bool try_external_command(char *argv[])
419 char *old_argv0 = argv[0];
422 argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);
425 * This will only return on errors. Not finding an external
426 * command (ENOENT) is not an error from our perspective.
428 execvp (argv[0], argv);
429 if (errno != ENOENT) {
430 fprintf (stderr, "Error: Running external command '%s' failed: %s\n",
431 argv[0], strerror(errno));
435 talloc_free (argv[0]);
442 main (int argc, char *argv[])
446 const char *command_name = NULL;
448 const char *config_file_name = NULL;
449 notmuch_config_t *config = NULL;
453 notmuch_opt_desc_t options[] = {
454 { .opt_string = &config_file_name, .name = "config" },
455 { .opt_inherit = notmuch_shared_options },
459 talloc_enable_null_tracking ();
461 local = talloc_new (NULL);
463 g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
464 #if !GLIB_CHECK_VERSION(2, 35, 1)
468 /* Globally default to the current output format version. */
469 notmuch_format_version = NOTMUCH_FORMAT_CUR;
471 opt_index = parse_arguments (argc, argv, options, 1);
477 if (opt_index < argc)
478 command_name = argv[opt_index];
480 notmuch_process_shared_options (command_name);
482 command = find_command (command_name);
484 /* This won't return if the external command is found. */
485 if (try_external_command(argv + opt_index))
486 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
492 config = notmuch_config_open (local, config_file_name, command->config_mode);
498 ret = (command->function)(config, argc - opt_index, argv + opt_index);
502 notmuch_config_close (config);
504 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
505 if (talloc_report && strcmp (talloc_report, "") != 0) {
506 /* this relies on the previous call to
507 * talloc_enable_null_tracking
510 FILE *report = fopen (talloc_report, "w");
512 talloc_report_full (NULL, report);
515 fprintf (stderr, "ERROR: unable to write talloc log. ");
516 perror (talloc_report);