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"
25 typedef int (*command_function_t) (notmuch_config_t *config, int argc, char *argv[]);
27 typedef struct command {
29 command_function_t function;
30 notmuch_bool_t create_config;
31 const char *arguments;
36 notmuch_help_command (notmuch_config_t *config, int argc, char *argv[]);
39 notmuch_command (notmuch_config_t *config, int argc, char *argv[]);
41 static command_t commands[] = {
42 { NULL, notmuch_command, TRUE,
44 "Notmuch main command." },
45 { "setup", notmuch_setup_command, TRUE,
47 "Interactively setup notmuch for first use." },
48 { "new", notmuch_new_command, FALSE,
50 "Find and import new messages to the notmuch database." },
51 { "search", notmuch_search_command, FALSE,
52 "[options...] <search-terms> [...]",
53 "Search for messages matching the given search terms." },
54 { "show", notmuch_show_command, FALSE,
55 "<search-terms> [...]",
56 "Show all messages matching the search terms." },
57 { "count", notmuch_count_command, FALSE,
58 "[options...] <search-terms> [...]",
59 "Count messages matching the search terms." },
60 { "reply", notmuch_reply_command, FALSE,
61 "[options...] <search-terms> [...]",
62 "Construct a reply template for a set of messages." },
63 { "tag", notmuch_tag_command, FALSE,
64 "+<tag>|-<tag> [...] [--] <search-terms> [...]" ,
65 "Add/remove tags for all messages matching the search terms." },
66 { "dump", notmuch_dump_command, FALSE,
67 "[<filename>] [--] [<search-terms>]",
68 "Create a plain-text dump of the tags for each message." },
69 { "restore", notmuch_restore_command, FALSE,
70 "[--accumulate] [<filename>]",
71 "Restore the tags from the given dump file (see 'dump')." },
72 { "config", notmuch_config_command, FALSE,
73 "[get|set] <section>.<item> [value ...]",
74 "Get or set settings in the notmuch configuration file." },
75 { "help", notmuch_help_command, TRUE, /* create but don't save config */
77 "This message, or more detailed help for the named command." }
81 find_command (const char *name)
85 for (i = 0; i < ARRAY_SIZE (commands); i++)
86 if ((!name && !commands[i].name) ||
87 (name && commands[i].name && strcmp (name, commands[i].name) == 0))
93 int notmuch_format_version;
102 "Usage: notmuch --help\n"
103 " notmuch --version\n"
104 " notmuch <command> [args...]\n");
106 fprintf (out, "The available commands are as follows:\n");
109 for (i = 0; i < ARRAY_SIZE (commands); i++) {
110 command = &commands[i];
113 fprintf (out, " %-11s %s\n", command->name, command->summary);
118 "Use \"notmuch help <command>\" for more details on each command\n"
119 "and \"notmuch help search-terms\" for the common search-terms syntax.\n\n");
123 notmuch_exit_if_unsupported_format (void)
125 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
127 A caller requested output format version %d, but the installed notmuch\n\
128 CLI only supports up to format version %d. You may need to upgrade your\n\
130 notmuch_format_version, NOTMUCH_FORMAT_CUR);
131 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
132 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
134 A caller requested output format version %d, which is no longer supported\n\
135 by the notmuch CLI (it requires at least version %d). You may need to\n\
136 upgrade your notmuch front-end.\n",
137 notmuch_format_version, NOTMUCH_FORMAT_MIN);
138 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
139 } else if (notmuch_format_version != NOTMUCH_FORMAT_CUR) {
140 /* Warn about old version requests so compatibility issues are
141 * less likely when we drop support for a deprecated format
144 A caller requested deprecated output format version %d, which may not\n\
145 be supported in the future.\n", notmuch_format_version);
150 exec_man (const char *page)
152 if (execlp ("man", "man", page, (char *) NULL)) {
159 notmuch_help_command (notmuch_config_t *config, int argc, char *argv[])
163 argc--; argv++; /* Ignore "help" */
166 printf ("The notmuch mail system.\n\n");
171 if (strcmp (argv[0], "help") == 0) {
172 printf ("The notmuch help system.\n\n"
173 "\tNotmuch uses the man command to display help. In case\n"
174 "\tof difficulties check that MANPATH includes the pages\n"
175 "\tinstalled by notmuch.\n\n"
176 "\tTry \"notmuch help\" for a list of topics.\n");
180 command = find_command (argv[0]);
182 char *page = talloc_asprintf (config, "notmuch-%s", command->name);
186 if (strcmp (argv[0], "search-terms") == 0) {
187 exec_man ("notmuch-search-terms");
188 } else if (strcmp (argv[0], "hooks") == 0) {
189 exec_man ("notmuch-hooks");
193 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
198 /* Handle the case of "notmuch" being invoked with no command
199 * argument. For now we just call notmuch_setup_command, but we plan
200 * to be more clever about this in the future.
203 notmuch_command (notmuch_config_t *config,
204 unused(int argc), unused(char *argv[]))
209 /* If the user has never configured notmuch, then run
210 * notmuch_setup_command which will give a nice welcome message,
211 * and interactively guide the user through the configuration. */
212 if (notmuch_config_is_new (config))
213 return notmuch_setup_command (config, 0, NULL);
215 /* Notmuch is already configured, but is there a database? */
216 db_path = talloc_asprintf (config, "%s/%s",
217 notmuch_config_get_database_path (config),
219 if (stat (db_path, &st)) {
220 if (errno != ENOENT) {
221 fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
222 db_path, strerror (errno));
225 printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
227 printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
228 "Note that the first run of \"notmuch new\" can take a very long time\n"
229 "and that the resulting database will use roughly the same amount of\n"
230 "storage space as the email being indexed.\n\n");
234 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
235 "At this point you can start exploring the functionality of notmuch by\n"
236 "using commands such as:\n\n"
237 "\tnotmuch search tag:inbox\n\n"
238 "\tnotmuch search to:\"%s\"\n\n"
239 "\tnotmuch search from:\"%s\"\n\n"
240 "\tnotmuch search subject:\"my favorite things\"\n\n"
241 "See \"notmuch help search\" for more details.\n\n"
242 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
243 "from a search. Finally, you may want to explore using a more sophisticated\n"
244 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
245 "or any other interface described at http://notmuchmail.org\n\n"
246 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
247 "Have fun, and may your inbox never have much mail.\n\n",
248 notmuch_config_get_user_name (config),
249 notmuch_config_get_user_primary_email (config));
255 main (int argc, char *argv[])
259 const char *command_name = NULL;
261 char *config_file_name = NULL;
262 notmuch_config_t *config;
263 notmuch_bool_t print_help=FALSE, print_version=FALSE;
267 notmuch_opt_desc_t options[] = {
268 { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
269 { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
270 { NOTMUCH_OPT_STRING, &config_file_name, "config", 'c', 0 },
274 talloc_enable_null_tracking ();
276 local = talloc_new (NULL);
281 /* Globally default to the current output format version. */
282 notmuch_format_version = NOTMUCH_FORMAT_CUR;
284 opt_index = parse_arguments (argc, argv, options, 1);
286 /* diagnostics already printed */
291 return notmuch_help_command (NULL, argc - 1, &argv[1]);
294 printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
298 if (opt_index < argc)
299 command_name = argv[opt_index];
301 command = find_command (command_name);
303 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
308 config = notmuch_config_open (local, config_file_name, command->create_config);
312 ret = (command->function)(config, argc - opt_index, argv + opt_index);
314 notmuch_config_close (config);
316 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
317 if (talloc_report && strcmp (talloc_report, "") != 0) {
318 /* this relies on the previous call to
319 * talloc_enable_null_tracking
322 FILE *report = fopen (talloc_report, "w");
324 talloc_report_full (NULL, report);
327 fprintf (stderr, "ERROR: unable to write talloc log. ");
328 perror (talloc_report);