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[]);
38 notmuch_command (void *ctx, int argc, char *argv[]);
40 static command_t commands[] = {
41 { NULL, notmuch_command,
43 "Notmuch main command." },
44 { "setup", notmuch_setup_command,
46 "Interactively setup notmuch for first use." },
47 { "new", notmuch_new_command,
49 "Find and import new messages to the notmuch database." },
50 { "search", notmuch_search_command,
51 "[options...] <search-terms> [...]",
52 "Search for messages matching the given search terms." },
53 { "show", notmuch_show_command,
54 "<search-terms> [...]",
55 "Show all messages matching the search terms." },
56 { "count", notmuch_count_command,
57 "[options...] <search-terms> [...]",
58 "Count messages matching the search terms." },
59 { "reply", notmuch_reply_command,
60 "[options...] <search-terms> [...]",
61 "Construct a reply template for a set of messages." },
62 { "tag", notmuch_tag_command,
63 "+<tag>|-<tag> [...] [--] <search-terms> [...]" ,
64 "Add/remove tags for all messages matching the search terms." },
65 { "dump", notmuch_dump_command,
66 "[<filename>] [--] [<search-terms>]",
67 "Create a plain-text dump of the tags for each message." },
68 { "restore", notmuch_restore_command,
69 "[--accumulate] [<filename>]",
70 "Restore the tags from the given dump file (see 'dump')." },
71 { "config", notmuch_config_command,
72 "[get|set] <section>.<item> [value ...]",
73 "Get or set settings in the notmuch configuration file." },
74 { "help", notmuch_help_command,
76 "This message, or more detailed help for the named command." }
80 find_command (const char *name)
84 for (i = 0; i < ARRAY_SIZE (commands); i++)
85 if ((!name && !commands[i].name) ||
86 (name && commands[i].name && strcmp (name, commands[i].name) == 0))
92 int notmuch_format_version;
101 "Usage: notmuch --help\n"
102 " notmuch --version\n"
103 " notmuch <command> [args...]\n");
105 fprintf (out, "The available commands are as follows:\n");
108 for (i = 0; i < ARRAY_SIZE (commands); i++) {
109 command = &commands[i];
112 fprintf (out, " %-11s %s\n", command->name, command->summary);
117 "Use \"notmuch help <command>\" for more details on each command\n"
118 "and \"notmuch help search-terms\" for the common search-terms syntax.\n\n");
122 notmuch_exit_if_unsupported_format (void)
124 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
126 A caller requested output format version %d, but the installed notmuch\n\
127 CLI only supports up to format version %d. You may need to upgrade your\n\
129 notmuch_format_version, NOTMUCH_FORMAT_CUR);
130 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
131 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
133 A caller requested output format version %d, which is no longer supported\n\
134 by the notmuch CLI (it requires at least version %d). You may need to\n\
135 upgrade your notmuch front-end.\n",
136 notmuch_format_version, NOTMUCH_FORMAT_MIN);
137 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
138 } else if (notmuch_format_version != NOTMUCH_FORMAT_CUR) {
139 /* Warn about old version requests so compatibility issues are
140 * less likely when we drop support for a deprecated format
143 A caller requested deprecated output format version %d, which may not\n\
144 be supported in the future.\n", notmuch_format_version);
149 exec_man (const char *page)
151 if (execlp ("man", "man", page, (char *) NULL)) {
158 notmuch_help_command (void *ctx, int argc, char *argv[])
162 argc--; argv++; /* Ignore "help" */
165 printf ("The notmuch mail system.\n\n");
170 if (strcmp (argv[0], "help") == 0) {
171 printf ("The notmuch help system.\n\n"
172 "\tNotmuch uses the man command to display help. In case\n"
173 "\tof difficulties check that MANPATH includes the pages\n"
174 "\tinstalled by notmuch.\n\n"
175 "\tTry \"notmuch help\" for a list of topics.\n");
179 command = find_command (argv[0]);
181 char *page = talloc_asprintf (ctx, "notmuch-%s", command->name);
185 if (strcmp (argv[0], "search-terms") == 0) {
186 exec_man ("notmuch-search-terms");
187 } else if (strcmp (argv[0], "hooks") == 0) {
188 exec_man ("notmuch-hooks");
192 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
197 /* Handle the case of "notmuch" being invoked with no command
198 * argument. For now we just call notmuch_setup_command, but we plan
199 * to be more clever about this in the future.
202 notmuch_command (void *ctx, unused(int argc), unused(char *argv[]))
204 notmuch_config_t *config;
205 notmuch_bool_t is_new;
209 config = notmuch_config_open (ctx, NULL, &is_new);
211 /* If the user has never configured notmuch, then run
212 * notmuch_setup_command which will give a nice welcome message,
213 * and interactively guide the user through the configuration. */
215 notmuch_config_close (config);
216 return notmuch_setup_command (ctx, 0, NULL);
219 /* Notmuch is already configured, but is there a database? */
220 db_path = talloc_asprintf (ctx, "%s/%s",
221 notmuch_config_get_database_path (config),
223 if (stat (db_path, &st)) {
224 notmuch_config_close (config);
225 if (errno != ENOENT) {
226 fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
227 db_path, strerror (errno));
230 printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
232 printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
233 "Note that the first run of \"notmuch new\" can take a very long time\n"
234 "and that the resulting database will use roughly the same amount of\n"
235 "storage space as the email being indexed.\n\n");
239 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
240 "At this point you can start exploring the functionality of notmuch by\n"
241 "using commands such as:\n\n"
242 "\tnotmuch search tag:inbox\n\n"
243 "\tnotmuch search to:\"%s\"\n\n"
244 "\tnotmuch search from:\"%s\"\n\n"
245 "\tnotmuch search subject:\"my favorite things\"\n\n"
246 "See \"notmuch help search\" for more details.\n\n"
247 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
248 "from a search. Finally, you may want to explore using a more sophisticated\n"
249 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
250 "or any other interface described at http://notmuchmail.org\n\n"
251 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
252 "Have fun, and may your inbox never have much mail.\n\n",
253 notmuch_config_get_user_name (config),
254 notmuch_config_get_user_primary_email (config));
256 notmuch_config_close (config);
262 main (int argc, char *argv[])
266 const char *command_name = NULL;
268 notmuch_bool_t print_help=FALSE, print_version=FALSE;
272 notmuch_opt_desc_t options[] = {
273 { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
274 { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
278 talloc_enable_null_tracking ();
280 local = talloc_new (NULL);
285 /* Globally default to the current output format version. */
286 notmuch_format_version = NOTMUCH_FORMAT_CUR;
288 opt_index = parse_arguments (argc, argv, options, 1);
290 /* diagnostics already printed */
295 return notmuch_help_command (NULL, argc - 1, &argv[1]);
298 printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
302 if (opt_index < argc)
303 command_name = argv[opt_index];
305 command = find_command (command_name);
307 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
312 ret = (command->function)(local, argc - opt_index, argv + opt_index);
314 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
315 if (talloc_report && strcmp (talloc_report, "") != 0) {
316 /* this relies on the previous call to
317 * talloc_enable_null_tracking
320 FILE *report = fopen (talloc_report, "w");
322 talloc_report_full (NULL, report);
325 fprintf (stderr, "ERROR: unable to write talloc log. ");
326 perror (talloc_report);