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) (void *ctx, int argc, char *argv[]);
27 typedef struct command {
29 command_function_t function;
30 const char *arguments;
35 notmuch_help_command (void *ctx, int argc, char *argv[]);
37 static command_t commands[] = {
38 { "setup", notmuch_setup_command,
40 "Interactively setup notmuch for first use." },
41 { "new", notmuch_new_command,
43 "Find and import new messages to the notmuch database." },
44 { "search", notmuch_search_command,
45 "[options...] <search-terms> [...]",
46 "Search for messages matching the given search terms." },
47 { "show", notmuch_show_command,
48 "<search-terms> [...]",
49 "Show all messages matching the search terms." },
50 { "count", notmuch_count_command,
51 "[options...] <search-terms> [...]",
52 "Count messages matching the search terms." },
53 { "reply", notmuch_reply_command,
54 "[options...] <search-terms> [...]",
55 "Construct a reply template for a set of messages." },
56 { "tag", notmuch_tag_command,
57 "+<tag>|-<tag> [...] [--] <search-terms> [...]" ,
58 "Add/remove tags for all messages matching the search terms." },
59 { "dump", notmuch_dump_command,
60 "[<filename>] [--] [<search-terms>]",
61 "Create a plain-text dump of the tags for each message." },
62 { "restore", notmuch_restore_command,
63 "[--accumulate] [<filename>]",
64 "Restore the tags from the given dump file (see 'dump')." },
65 { "config", notmuch_config_command,
66 "[get|set] <section>.<item> [value ...]",
67 "Get or set settings in the notmuch configuration file." },
68 { "help", notmuch_help_command,
70 "This message, or more detailed help for the named command." }
73 int notmuch_format_version;
82 "Usage: notmuch --help\n"
83 " notmuch --version\n"
84 " notmuch <command> [args...]\n");
86 fprintf (out, "The available commands are as follows:\n");
89 for (i = 0; i < ARRAY_SIZE (commands); i++) {
90 command = &commands[i];
92 fprintf (out, " %-11s %s\n",
93 command->name, command->summary);
98 "Use \"notmuch help <command>\" for more details on each command\n"
99 "and \"notmuch help search-terms\" for the common search-terms syntax.\n\n");
103 notmuch_exit_if_unsupported_format (void)
105 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
107 A caller requested output format version %d, but the installed notmuch\n\
108 CLI only supports up to format version %d. You may need to upgrade your\n\
110 notmuch_format_version, NOTMUCH_FORMAT_CUR);
111 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
112 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
114 A caller requested output format version %d, which is no longer supported\n\
115 by the notmuch CLI (it requires at least version %d). You may need to\n\
116 upgrade your notmuch front-end.\n",
117 notmuch_format_version, NOTMUCH_FORMAT_MIN);
118 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
119 } else if (notmuch_format_version != NOTMUCH_FORMAT_CUR) {
120 /* Warn about old version requests so compatibility issues are
121 * less likely when we drop support for a deprecated format
124 A caller requested deprecated output format version %d, which may not\n\
125 be supported in the future.\n", notmuch_format_version);
130 exec_man (const char *page)
132 if (execlp ("man", "man", page, (char *) NULL)) {
139 notmuch_help_command (void *ctx, int argc, char *argv[])
144 argc--; argv++; /* Ignore "help" */
147 printf ("The notmuch mail system.\n\n");
152 if (strcmp (argv[0], "help") == 0) {
153 printf ("The notmuch help system.\n\n"
154 "\tNotmuch uses the man command to display help. In case\n"
155 "\tof difficulties check that MANPATH includes the pages\n"
156 "\tinstalled by notmuch.\n\n"
157 "\tTry \"notmuch help\" for a list of topics.\n");
161 for (i = 0; i < ARRAY_SIZE (commands); i++) {
162 command = &commands[i];
164 if (strcmp (argv[0], command->name) == 0) {
165 char *page = talloc_asprintf (ctx, "notmuch-%s", command->name);
170 if (strcmp (argv[0], "search-terms") == 0) {
171 exec_man ("notmuch-search-terms");
172 } else if (strcmp (argv[0], "hooks") == 0) {
173 exec_man ("notmuch-hooks");
177 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
182 /* Handle the case of "notmuch" being invoked with no command
183 * argument. For now we just call notmuch_setup_command, but we plan
184 * to be more clever about this in the future.
189 notmuch_config_t *config;
190 notmuch_bool_t is_new;
194 config = notmuch_config_open (ctx, NULL, &is_new);
196 /* If the user has never configured notmuch, then run
197 * notmuch_setup_command which will give a nice welcome message,
198 * and interactively guide the user through the configuration. */
200 notmuch_config_close (config);
201 return notmuch_setup_command (ctx, 0, NULL);
204 /* Notmuch is already configured, but is there a database? */
205 db_path = talloc_asprintf (ctx, "%s/%s",
206 notmuch_config_get_database_path (config),
208 if (stat (db_path, &st)) {
209 notmuch_config_close (config);
210 if (errno != ENOENT) {
211 fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
212 db_path, strerror (errno));
215 printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
217 printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
218 "Note that the first run of \"notmuch new\" can take a very long time\n"
219 "and that the resulting database will use roughly the same amount of\n"
220 "storage space as the email being indexed.\n\n");
224 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
225 "At this point you can start exploring the functionality of notmuch by\n"
226 "using commands such as:\n\n"
227 "\tnotmuch search tag:inbox\n\n"
228 "\tnotmuch search to:\"%s\"\n\n"
229 "\tnotmuch search from:\"%s\"\n\n"
230 "\tnotmuch search subject:\"my favorite things\"\n\n"
231 "See \"notmuch help search\" for more details.\n\n"
232 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
233 "from a search. Finally, you may want to explore using a more sophisticated\n"
234 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
235 "or any other interface described at http://notmuchmail.org\n\n"
236 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
237 "Have fun, and may your inbox never have much mail.\n\n",
238 notmuch_config_get_user_name (config),
239 notmuch_config_get_user_primary_email (config));
241 notmuch_config_close (config);
247 main (int argc, char *argv[])
252 notmuch_bool_t print_help=FALSE, print_version=FALSE;
255 notmuch_opt_desc_t options[] = {
256 { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
257 { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
261 talloc_enable_null_tracking ();
263 local = talloc_new (NULL);
268 /* Globally default to the current output format version. */
269 notmuch_format_version = NOTMUCH_FORMAT_CUR;
272 return notmuch (local);
274 opt_index = parse_arguments (argc, argv, options, 1);
276 /* diagnostics already printed */
281 return notmuch_help_command (NULL, argc - 1, &argv[1]);
284 printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
288 for (i = 0; i < ARRAY_SIZE (commands); i++) {
289 command = &commands[i];
291 if (strcmp (argv[opt_index], command->name) == 0) {
295 ret = (command->function)(local, argc - opt_index, argv + opt_index);
297 /* in the future support for this environment variable may
298 * be supplemented or replaced by command line arguments
299 * --leak-report and/or --leak-report-full */
301 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
303 /* this relies on the previous call to
304 * talloc_enable_null_tracking */
306 if (talloc_report && strcmp (talloc_report, "") != 0) {
307 FILE *report = fopen (talloc_report, "w");
308 talloc_report_full (NULL, report);
315 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",