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 http://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_bool_t create_config;
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;
51 const notmuch_opt_desc_t notmuch_shared_options [] = {
52 { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
53 { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
57 /* any subcommand wanting to support these options should call
58 * inherit notmuch_shared_options and call
59 * notmuch_process_shared_options (subcommand_name);
62 notmuch_process_shared_options (const char *subcommand_name) {
64 printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
69 int ret = _help_for (subcommand_name);
74 /* This is suitable for subcommands that do not actually open the
77 int notmuch_minimal_options (const char *subcommand_name,
78 int argc, char **argv)
82 notmuch_opt_desc_t options[] = {
83 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
87 opt_index = parse_arguments (argc, argv, options, 1);
92 /* We can't use argv here as it is sometimes NULL */
93 notmuch_process_shared_options (subcommand_name);
97 static command_t commands[] = {
98 { NULL, notmuch_command, TRUE,
99 "Notmuch main command." },
100 { "setup", notmuch_setup_command, TRUE,
101 "Interactively set up notmuch for first use." },
102 { "new", notmuch_new_command, FALSE,
103 "Find and import new messages to the notmuch database." },
104 { "insert", notmuch_insert_command, FALSE,
105 "Add a new message into the maildir and notmuch database." },
106 { "search", notmuch_search_command, FALSE,
107 "Search for messages matching the given search terms." },
108 { "address", notmuch_address_command, FALSE,
109 "Get addresses from messages matching the given search terms." },
110 { "show", notmuch_show_command, FALSE,
111 "Show all messages matching the search terms." },
112 { "count", notmuch_count_command, FALSE,
113 "Count messages matching the search terms." },
114 { "reply", notmuch_reply_command, FALSE,
115 "Construct a reply template for a set of messages." },
116 { "tag", notmuch_tag_command, FALSE,
117 "Add/remove tags for all messages matching the search terms." },
118 { "dump", notmuch_dump_command, FALSE,
119 "Create a plain-text dump of the tags for each message." },
120 { "restore", notmuch_restore_command, FALSE,
121 "Restore the tags from the given dump file (see 'dump')." },
122 { "compact", notmuch_compact_command, FALSE,
123 "Compact the notmuch database." },
124 { "config", notmuch_config_command, FALSE,
125 "Get or set settings in the notmuch configuration file." },
126 { "help", notmuch_help_command, TRUE, /* create but don't save config */
127 "This message, or more detailed help for the named command." }
130 typedef struct help_topic {
135 static help_topic_t help_topics[] = {
137 "Common search term syntax." },
139 "Hooks that will be run before or after certain commands." },
143 find_command (const char *name)
147 for (i = 0; i < ARRAY_SIZE (commands); i++)
148 if ((!name && !commands[i].name) ||
149 (name && commands[i].name && strcmp (name, commands[i].name) == 0))
155 int notmuch_format_version;
165 "Usage: notmuch --help\n"
166 " notmuch --version\n"
167 " notmuch <command> [args...]\n");
169 fprintf (out, "The available commands are as follows:\n");
172 for (i = 0; i < ARRAY_SIZE (commands); i++) {
173 command = &commands[i];
176 fprintf (out, " %-12s %s\n", command->name, command->summary);
180 fprintf (out, "Additional help topics are as follows:\n");
183 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
184 topic = &help_topics[i];
185 fprintf (out, " %-12s %s\n", topic->name, topic->summary);
190 "Use \"notmuch help <command or topic>\" for more details "
191 "on each command or topic.\n\n");
195 notmuch_exit_if_unsupported_format (void)
197 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
199 A caller requested output format version %d, but the installed notmuch\n\
200 CLI only supports up to format version %d. You may need to upgrade your\n\
202 notmuch_format_version, NOTMUCH_FORMAT_CUR);
203 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
204 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
206 A caller requested output format version %d, which is no longer supported\n\
207 by the notmuch CLI (it requires at least version %d). You may need to\n\
208 upgrade your notmuch front-end.\n",
209 notmuch_format_version, NOTMUCH_FORMAT_MIN);
210 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
211 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
212 /* Warn about old version requests so compatibility issues are
213 * less likely when we drop support for a deprecated format
216 A caller requested deprecated output format version %d, which may not\n\
217 be supported in the future.\n", notmuch_format_version);
222 exec_man (const char *page)
224 if (execlp ("man", "man", page, (char *) NULL)) {
231 _help_for (const char *topic_name)
238 printf ("The notmuch mail system.\n\n");
243 if (strcmp (topic_name, "help") == 0) {
244 printf ("The notmuch help system.\n\n"
245 "\tNotmuch uses the man command to display help. In case\n"
246 "\tof difficulties check that MANPATH includes the pages\n"
247 "\tinstalled by notmuch.\n\n"
248 "\tTry \"notmuch help\" for a list of topics.\n");
252 command = find_command (topic_name);
254 char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
258 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
259 topic = &help_topics[i];
260 if (strcmp (topic_name, topic->name) == 0) {
261 char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);
267 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
273 notmuch_help_command (unused (notmuch_config_t * config), int argc, char *argv[])
277 opt_index = notmuch_minimal_options ("help", argc, argv);
281 /* skip at least subcommand argument */
286 return _help_for (NULL);
289 return _help_for (argv[0]);
292 /* Handle the case of "notmuch" being invoked with no command
293 * argument. For now we just call notmuch_setup_command, but we plan
294 * to be more clever about this in the future.
297 notmuch_command (notmuch_config_t *config,
298 unused(int argc), unused(char *argv[]))
303 /* If the user has never configured notmuch, then run
304 * notmuch_setup_command which will give a nice welcome message,
305 * and interactively guide the user through the configuration. */
306 if (notmuch_config_is_new (config))
307 return notmuch_setup_command (config, 0, NULL);
309 /* Notmuch is already configured, but is there a database? */
310 db_path = talloc_asprintf (config, "%s/%s",
311 notmuch_config_get_database_path (config),
313 if (stat (db_path, &st)) {
314 if (errno != ENOENT) {
315 fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
316 db_path, strerror (errno));
319 printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
321 printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
322 "Note that the first run of \"notmuch new\" can take a very long time\n"
323 "and that the resulting database will use roughly the same amount of\n"
324 "storage space as the email being indexed.\n\n");
328 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
329 "At this point you can start exploring the functionality of notmuch by\n"
330 "using commands such as:\n\n"
331 "\tnotmuch search tag:inbox\n\n"
332 "\tnotmuch search to:\"%s\"\n\n"
333 "\tnotmuch search from:\"%s\"\n\n"
334 "\tnotmuch search subject:\"my favorite things\"\n\n"
335 "See \"notmuch help search\" for more details.\n\n"
336 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
337 "from a search. Finally, you may want to explore using a more sophisticated\n"
338 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
339 "or any other interface described at http://notmuchmail.org\n\n"
340 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
341 "Have fun, and may your inbox never have much mail.\n\n",
342 notmuch_config_get_user_name (config),
343 notmuch_config_get_user_primary_email (config));
349 main (int argc, char *argv[])
353 const char *command_name = NULL;
355 char *config_file_name = NULL;
356 notmuch_config_t *config = NULL;
360 notmuch_opt_desc_t options[] = {
361 { NOTMUCH_OPT_STRING, &config_file_name, "config", 'c', 0 },
362 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
366 talloc_enable_null_tracking ();
368 local = talloc_new (NULL);
370 g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
371 #if !GLIB_CHECK_VERSION(2, 35, 1)
375 /* Globally default to the current output format version. */
376 notmuch_format_version = NOTMUCH_FORMAT_CUR;
378 opt_index = parse_arguments (argc, argv, options, 1);
384 if (opt_index < argc)
385 command_name = argv[opt_index];
387 notmuch_process_shared_options (command_name);
389 command = find_command (command_name);
391 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
397 config = notmuch_config_open (local, config_file_name, command->create_config);
403 ret = (command->function)(config, argc - opt_index, argv + opt_index);
407 notmuch_config_close (config);
409 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
410 if (talloc_report && strcmp (talloc_report, "") != 0) {
411 /* this relies on the previous call to
412 * talloc_enable_null_tracking
415 FILE *report = fopen (talloc_report, "w");
417 talloc_report_full (NULL, report);
420 fprintf (stderr, "ERROR: unable to write talloc log. ");
421 perror (talloc_report);