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;
34 #define MAX_ALIAS_SUBSTITUTIONS 3
36 typedef struct alias {
38 const char *substitutions[MAX_ALIAS_SUBSTITUTIONS];
42 { "part", { "show", "--format=raw"}},
43 { "search-tags", {"search", "--output=tags", "*"}}
47 notmuch_help_command (void *ctx, int argc, char *argv[]);
49 static command_t commands[] = {
50 { "setup", notmuch_setup_command,
52 "Interactively setup notmuch for first use." },
53 { "new", notmuch_new_command,
55 "Find and import new messages to the notmuch database." },
56 { "search", notmuch_search_command,
57 "[options...] <search-terms> [...]",
58 "Search for messages matching the given search terms." },
59 { "show", notmuch_show_command,
60 "<search-terms> [...]",
61 "Show all messages matching the search terms." },
62 { "count", notmuch_count_command,
63 "[options...] <search-terms> [...]",
64 "Count messages matching the search terms." },
65 { "reply", notmuch_reply_command,
66 "[options...] <search-terms> [...]",
67 "Construct a reply template for a set of messages." },
68 { "tag", notmuch_tag_command,
69 "+<tag>|-<tag> [...] [--] <search-terms> [...]" ,
70 "Add/remove tags for all messages matching the search terms." },
71 { "dump", notmuch_dump_command,
72 "[<filename>] [--] [<search-terms>]",
73 "Create a plain-text dump of the tags for each message." },
74 { "restore", notmuch_restore_command,
75 "[--accumulate] [<filename>]",
76 "Restore the tags from the given dump file (see 'dump')." },
77 { "config", notmuch_config_command,
78 "[get|set] <section>.<item> [value ...]",
79 "Get or set settings in the notmuch configuration file." },
80 { "help", notmuch_help_command,
82 "This message, or more detailed help for the named command." }
85 int notmuch_format_version;
94 "Usage: notmuch --help\n"
95 " notmuch --version\n"
96 " notmuch <command> [args...]\n");
98 fprintf (out, "The available commands are as follows:\n");
101 for (i = 0; i < ARRAY_SIZE (commands); i++) {
102 command = &commands[i];
104 fprintf (out, " %-11s %s\n",
105 command->name, command->summary);
110 "Use \"notmuch help <command>\" for more details on each command\n"
111 "and \"notmuch help search-terms\" for the common search-terms syntax.\n\n");
115 notmuch_exit_if_unsupported_format (void)
117 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
119 A caller requested output format version %d, but the installed notmuch\n\
120 CLI only supports up to format version %d. You may need to upgrade your\n\
122 notmuch_format_version, NOTMUCH_FORMAT_CUR);
123 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
124 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
126 A caller requested output format version %d, which is no longer supported\n\
127 by the notmuch CLI (it requires at least version %d). You may need to\n\
128 upgrade your notmuch front-end.\n",
129 notmuch_format_version, NOTMUCH_FORMAT_MIN);
130 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
131 } else if (notmuch_format_version != NOTMUCH_FORMAT_CUR) {
132 /* Warn about old version requests so compatibility issues are
133 * less likely when we drop support for a deprecated format
136 A caller requested deprecated output format version %d, which may not\n\
137 be supported in the future.\n", notmuch_format_version);
142 exec_man (const char *page)
144 if (execlp ("man", "man", page, (char *) NULL)) {
151 notmuch_help_command (void *ctx, int argc, char *argv[])
156 argc--; argv++; /* Ignore "help" */
159 printf ("The notmuch mail system.\n\n");
164 if (strcmp (argv[0], "help") == 0) {
165 printf ("The notmuch help system.\n\n"
166 "\tNotmuch uses the man command to display help. In case\n"
167 "\tof difficulties check that MANPATH includes the pages\n"
168 "\tinstalled by notmuch.\n\n"
169 "\tTry \"notmuch help\" for a list of topics.\n");
173 for (i = 0; i < ARRAY_SIZE (commands); i++) {
174 command = &commands[i];
176 if (strcmp (argv[0], command->name) == 0) {
177 char *page = talloc_asprintf (ctx, "notmuch-%s", command->name);
182 if (strcmp (argv[0], "search-terms") == 0) {
183 exec_man ("notmuch-search-terms");
184 } else if (strcmp (argv[0], "hooks") == 0) {
185 exec_man ("notmuch-hooks");
189 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
194 /* Handle the case of "notmuch" being invoked with no command
195 * argument. For now we just call notmuch_setup_command, but we plan
196 * to be more clever about this in the future.
201 notmuch_config_t *config;
202 notmuch_bool_t is_new;
206 config = notmuch_config_open (ctx, NULL, &is_new);
208 /* If the user has never configured notmuch, then run
209 * notmuch_setup_command which will give a nice welcome message,
210 * and interactively guide the user through the configuration. */
212 notmuch_config_close (config);
213 return notmuch_setup_command (ctx, 0, NULL);
216 /* Notmuch is already configured, but is there a database? */
217 db_path = talloc_asprintf (ctx, "%s/%s",
218 notmuch_config_get_database_path (config),
220 if (stat (db_path, &st)) {
221 notmuch_config_close (config);
222 if (errno != ENOENT) {
223 fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
224 db_path, strerror (errno));
227 printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
229 printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
230 "Note that the first run of \"notmuch new\" can take a very long time\n"
231 "and that the resulting database will use roughly the same amount of\n"
232 "storage space as the email being indexed.\n\n");
236 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
237 "At this point you can start exploring the functionality of notmuch by\n"
238 "using commands such as:\n\n"
239 "\tnotmuch search tag:inbox\n\n"
240 "\tnotmuch search to:\"%s\"\n\n"
241 "\tnotmuch search from:\"%s\"\n\n"
242 "\tnotmuch search subject:\"my favorite things\"\n\n"
243 "See \"notmuch help search\" for more details.\n\n"
244 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
245 "from a search. Finally, you may want to explore using a more sophisticated\n"
246 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
247 "or any other interface described at http://notmuchmail.org\n\n"
248 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
249 "Have fun, and may your inbox never have much mail.\n\n",
250 notmuch_config_get_user_name (config),
251 notmuch_config_get_user_primary_email (config));
253 notmuch_config_close (config);
259 main (int argc, char *argv[])
265 const char **argv_local;
267 talloc_enable_null_tracking ();
269 local = talloc_new (NULL);
274 /* Globally default to the current output format version. */
275 notmuch_format_version = NOTMUCH_FORMAT_CUR;
278 return notmuch (local);
280 if (strcmp (argv[1], "--help") == 0)
281 return notmuch_help_command (NULL, argc - 1, &argv[1]);
283 if (strcmp (argv[1], "--version") == 0) {
284 printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
288 for (i = 0; i < ARRAY_SIZE (aliases); i++) {
291 if (strcmp (argv[1], alias->name) == 0)
295 argv_local = talloc_size (local, sizeof (char *) *
296 (argc + MAX_ALIAS_SUBSTITUTIONS - 1));
297 if (argv_local == NULL) {
298 fprintf (stderr, "Out of memory.\n");
302 /* Copy all substution arguments from the alias. */
303 argv_local[0] = argv[0];
304 for (j = 0; j < MAX_ALIAS_SUBSTITUTIONS; j++) {
305 if (alias->substitutions[j] == NULL)
307 argv_local[j+1] = alias->substitutions[j];
311 /* And copy all original arguments (skipping the argument
312 * that matched the alias of course. */
313 for (j = 2; j < (unsigned) argc; j++) {
314 argv_local[substitutions+j-1] = argv[j];
317 argc += substitutions - 1;
318 argv = (char **) argv_local;
322 for (i = 0; i < ARRAY_SIZE (commands); i++) {
323 command = &commands[i];
325 if (strcmp (argv[1], command->name) == 0) {
329 ret = (command->function)(local, argc - 1, &argv[1]);
331 /* in the future support for this environment variable may
332 * be supplemented or replaced by command line arguments
333 * --leak-report and/or --leak-report-full */
335 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
337 /* this relies on the previous call to
338 * talloc_enable_null_tracking */
340 if (talloc_report && strcmp (talloc_report, "") != 0) {
341 FILE *report = fopen (talloc_report, "w");
342 talloc_report_full (NULL, report);
349 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",