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 notmuch_bool_t print_version = FALSE, print_help = FALSE;
50 char *notmuch_requested_db_uuid = NULL;
52 const notmuch_opt_desc_t notmuch_shared_options [] = {
53 { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
54 { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
55 { NOTMUCH_OPT_STRING, ¬much_requested_db_uuid, "uuid", 'u', 0 },
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 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
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);
99 static command_t commands[] = {
100 { NULL, notmuch_command, NOTMUCH_CONFIG_OPEN | NOTMUCH_CONFIG_CREATE,
101 "Notmuch main command." },
102 { "setup", notmuch_setup_command, NOTMUCH_CONFIG_OPEN | NOTMUCH_CONFIG_CREATE,
103 "Interactively set up notmuch for first use." },
104 { "new", notmuch_new_command, NOTMUCH_CONFIG_OPEN,
105 "Find and import new messages to the notmuch database." },
106 { "insert", notmuch_insert_command, NOTMUCH_CONFIG_OPEN,
107 "Add a new message into the maildir and notmuch database." },
108 { "search", notmuch_search_command, NOTMUCH_CONFIG_OPEN,
109 "Search for messages matching the given search terms." },
110 { "address", notmuch_address_command, NOTMUCH_CONFIG_OPEN,
111 "Get addresses from messages matching the given search terms." },
112 { "show", notmuch_show_command, NOTMUCH_CONFIG_OPEN,
113 "Show all messages matching the search terms." },
114 { "count", notmuch_count_command, NOTMUCH_CONFIG_OPEN,
115 "Count messages matching the search terms." },
116 { "reply", notmuch_reply_command, NOTMUCH_CONFIG_OPEN,
117 "Construct a reply template for a set of messages." },
118 { "tag", notmuch_tag_command, NOTMUCH_CONFIG_OPEN,
119 "Add/remove tags for all messages matching the search terms." },
120 { "dump", notmuch_dump_command, NOTMUCH_CONFIG_OPEN,
121 "Create a plain-text dump of the tags for each message." },
122 { "restore", notmuch_restore_command, NOTMUCH_CONFIG_OPEN,
123 "Restore the tags from the given dump file (see 'dump')." },
124 { "compact", notmuch_compact_command, NOTMUCH_CONFIG_OPEN,
125 "Compact the notmuch database." },
126 { "reindex", notmuch_reindex_command, NOTMUCH_CONFIG_OPEN,
127 "Re-index all messages matching the search terms." },
128 { "config", notmuch_config_command, NOTMUCH_CONFIG_OPEN,
129 "Get or set settings in the notmuch configuration file." },
130 { "help", notmuch_help_command, NOTMUCH_CONFIG_CREATE, /* create but don't save config */
131 "This message, or more detailed help for the named command." }
134 typedef struct help_topic {
139 static help_topic_t help_topics[] = {
141 "Common search term syntax." },
143 "Hooks that will be run before or after certain commands." },
147 find_command (const char *name)
151 for (i = 0; i < ARRAY_SIZE (commands); i++)
152 if ((!name && !commands[i].name) ||
153 (name && commands[i].name && strcmp (name, commands[i].name) == 0))
159 int notmuch_format_version;
169 "Usage: notmuch --help\n"
170 " notmuch --version\n"
171 " notmuch <command> [args...]\n");
173 fprintf (out, "The available commands are as follows:\n");
176 for (i = 0; i < ARRAY_SIZE (commands); i++) {
177 command = &commands[i];
180 fprintf (out, " %-12s %s\n", command->name, command->summary);
184 fprintf (out, "Additional help topics are as follows:\n");
187 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
188 topic = &help_topics[i];
189 fprintf (out, " %-12s %s\n", topic->name, topic->summary);
194 "Use \"notmuch help <command or topic>\" for more details "
195 "on each command or topic.\n\n");
199 notmuch_exit_if_unsupported_format (void)
201 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
203 A caller requested output format version %d, but the installed notmuch\n\
204 CLI only supports up to format version %d. You may need to upgrade your\n\
206 notmuch_format_version, NOTMUCH_FORMAT_CUR);
207 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
208 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
210 A caller requested output format version %d, which is no longer supported\n\
211 by the notmuch CLI (it requires at least version %d). You may need to\n\
212 upgrade your notmuch front-end.\n",
213 notmuch_format_version, NOTMUCH_FORMAT_MIN);
214 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
215 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
216 /* Warn about old version requests so compatibility issues are
217 * less likely when we drop support for a deprecated format
220 A caller requested deprecated output format version %d, which may not\n\
221 be supported in the future.\n", notmuch_format_version);
226 notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
228 const char *uuid = NULL;
230 if (!notmuch_requested_db_uuid)
232 IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));
234 if (strcmp (notmuch_requested_db_uuid, uuid) != 0){
235 fprintf (stderr, "Error: requested database revision %s does not match %s\n",
236 notmuch_requested_db_uuid, uuid);
242 exec_man (const char *page)
244 if (execlp ("man", "man", page, (char *) NULL)) {
251 _help_for (const char *topic_name)
258 printf ("The notmuch mail system.\n\n");
263 if (strcmp (topic_name, "help") == 0) {
264 printf ("The notmuch help system.\n\n"
265 "\tNotmuch uses the man command to display help. In case\n"
266 "\tof difficulties check that MANPATH includes the pages\n"
267 "\tinstalled by notmuch.\n\n"
268 "\tTry \"notmuch help\" for a list of topics.\n");
272 command = find_command (topic_name);
274 char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
278 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
279 topic = &help_topics[i];
280 if (strcmp (topic_name, topic->name) == 0) {
281 char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);
287 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
293 notmuch_help_command (unused (notmuch_config_t * config), int argc, char *argv[])
297 opt_index = notmuch_minimal_options ("help", argc, argv);
301 /* skip at least subcommand argument */
306 return _help_for (NULL);
309 return _help_for (argv[0]);
312 /* Handle the case of "notmuch" being invoked with no command
313 * argument. For now we just call notmuch_setup_command, but we plan
314 * to be more clever about this in the future.
317 notmuch_command (notmuch_config_t *config,
318 unused(int argc), unused(char *argv[]))
323 /* If the user has never configured notmuch, then run
324 * notmuch_setup_command which will give a nice welcome message,
325 * and interactively guide the user through the configuration. */
326 if (notmuch_config_is_new (config))
327 return notmuch_setup_command (config, 0, NULL);
329 /* Notmuch is already configured, but is there a database? */
330 db_path = talloc_asprintf (config, "%s/%s",
331 notmuch_config_get_database_path (config),
333 if (stat (db_path, &st)) {
334 if (errno != ENOENT) {
335 fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
336 db_path, strerror (errno));
339 printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
341 printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
342 "Note that the first run of \"notmuch new\" can take a very long time\n"
343 "and that the resulting database will use roughly the same amount of\n"
344 "storage space as the email being indexed.\n\n");
348 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
349 "At this point you can start exploring the functionality of notmuch by\n"
350 "using commands such as:\n\n"
351 "\tnotmuch search tag:inbox\n\n"
352 "\tnotmuch search to:\"%s\"\n\n"
353 "\tnotmuch search from:\"%s\"\n\n"
354 "\tnotmuch search subject:\"my favorite things\"\n\n"
355 "See \"notmuch help search\" for more details.\n\n"
356 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
357 "from a search. Finally, you may want to explore using a more sophisticated\n"
358 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
359 "or any other interface described at https://notmuchmail.org\n\n"
360 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
361 "Have fun, and may your inbox never have much mail.\n\n",
362 notmuch_config_get_user_name (config),
363 notmuch_config_get_user_primary_email (config));
369 * Try to run subcommand in argv[0] as notmuch- prefixed external
370 * command. argv must be NULL terminated (argv passed to main always
373 * Does not return if the external command is found and
374 * executed. Return TRUE if external command is not found. Return
377 static notmuch_bool_t try_external_command(char *argv[])
379 char *old_argv0 = argv[0];
380 notmuch_bool_t ret = TRUE;
382 argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);
385 * This will only return on errors. Not finding an external
386 * command (ENOENT) is not an error from our perspective.
388 execvp (argv[0], argv);
389 if (errno != ENOENT) {
390 fprintf (stderr, "Error: Running external command '%s' failed: %s\n",
391 argv[0], strerror(errno));
395 talloc_free (argv[0]);
402 main (int argc, char *argv[])
406 const char *command_name = NULL;
408 char *config_file_name = NULL;
409 notmuch_config_t *config = NULL;
413 notmuch_opt_desc_t options[] = {
414 { NOTMUCH_OPT_STRING, &config_file_name, "config", 'c', 0 },
415 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
419 talloc_enable_null_tracking ();
421 local = talloc_new (NULL);
423 g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
424 #if !GLIB_CHECK_VERSION(2, 35, 1)
428 /* Globally default to the current output format version. */
429 notmuch_format_version = NOTMUCH_FORMAT_CUR;
431 opt_index = parse_arguments (argc, argv, options, 1);
437 if (opt_index < argc)
438 command_name = argv[opt_index];
440 notmuch_process_shared_options (command_name);
442 command = find_command (command_name);
444 /* This won't return if the external command is found. */
445 if (try_external_command(argv + opt_index))
446 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
452 config = notmuch_config_open (local, config_file_name, command->config_mode);
458 ret = (command->function)(config, argc - opt_index, argv + opt_index);
462 notmuch_config_close (config);
464 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
465 if (talloc_report && strcmp (talloc_report, "") != 0) {
466 /* this relies on the previous call to
467 * talloc_enable_null_tracking
470 FILE *report = fopen (talloc_report, "w");
472 talloc_report_full (NULL, report);
475 fprintf (stderr, "ERROR: unable to write talloc log. ");
476 perror (talloc_report);