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[]);
46 static command_t commands[] = {
47 { NULL, notmuch_command, TRUE,
48 "Notmuch main command." },
49 { "setup", notmuch_setup_command, TRUE,
50 "Interactively setup notmuch for first use." },
51 { "new", notmuch_new_command, FALSE,
52 "Find and import new messages to the notmuch database." },
53 { "insert", notmuch_insert_command, FALSE,
54 "Add a new message into the maildir and notmuch database." },
55 { "search", notmuch_search_command, FALSE,
56 "Search for messages matching the given search terms." },
57 { "show", notmuch_show_command, FALSE,
58 "Show all messages matching the search terms." },
59 { "count", notmuch_count_command, FALSE,
60 "Count messages matching the search terms." },
61 { "reply", notmuch_reply_command, FALSE,
62 "Construct a reply template for a set of messages." },
63 { "tag", notmuch_tag_command, FALSE,
64 "Add/remove tags for all messages matching the search terms." },
65 { "dump", notmuch_dump_command, FALSE,
66 "Create a plain-text dump of the tags for each message." },
67 { "restore", notmuch_restore_command, FALSE,
68 "Restore the tags from the given dump file (see 'dump')." },
69 { "compact", notmuch_compact_command, FALSE,
70 "Compact the notmuch database." },
71 { "config", notmuch_config_command, FALSE,
72 "Get or set settings in the notmuch configuration file." },
73 { "help", notmuch_help_command, TRUE, /* create but don't save config */
74 "This message, or more detailed help for the named command." }
78 find_command (const char *name)
82 for (i = 0; i < ARRAY_SIZE (commands); i++)
83 if ((!name && !commands[i].name) ||
84 (name && commands[i].name && strcmp (name, commands[i].name) == 0))
90 int notmuch_format_version;
99 "Usage: notmuch --help\n"
100 " notmuch --version\n"
101 " notmuch <command> [args...]\n");
103 fprintf (out, "The available commands are as follows:\n");
106 for (i = 0; i < ARRAY_SIZE (commands); i++) {
107 command = &commands[i];
110 fprintf (out, " %-11s %s\n", command->name, command->summary);
115 "Use \"notmuch help <command>\" for more details on each command\n"
116 "and \"notmuch help search-terms\" for the common search-terms syntax.\n\n");
120 notmuch_exit_if_unsupported_format (void)
122 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
124 A caller requested output format version %d, but the installed notmuch\n\
125 CLI only supports up to format version %d. You may need to upgrade your\n\
127 notmuch_format_version, NOTMUCH_FORMAT_CUR);
128 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
129 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
131 A caller requested output format version %d, which is no longer supported\n\
132 by the notmuch CLI (it requires at least version %d). You may need to\n\
133 upgrade your notmuch front-end.\n",
134 notmuch_format_version, NOTMUCH_FORMAT_MIN);
135 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
136 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
137 /* Warn about old version requests so compatibility issues are
138 * less likely when we drop support for a deprecated format
141 A caller requested deprecated output format version %d, which may not\n\
142 be supported in the future.\n", notmuch_format_version);
147 exec_man (const char *page)
149 if (execlp ("man", "man", page, (char *) NULL)) {
156 notmuch_help_command (notmuch_config_t *config, int argc, char *argv[])
160 argc--; argv++; /* Ignore "help" */
163 printf ("The notmuch mail system.\n\n");
168 if (strcmp (argv[0], "help") == 0) {
169 printf ("The notmuch help system.\n\n"
170 "\tNotmuch uses the man command to display help. In case\n"
171 "\tof difficulties check that MANPATH includes the pages\n"
172 "\tinstalled by notmuch.\n\n"
173 "\tTry \"notmuch help\" for a list of topics.\n");
177 command = find_command (argv[0]);
179 char *page = talloc_asprintf (config, "notmuch-%s", command->name);
183 if (strcmp (argv[0], "search-terms") == 0) {
184 exec_man ("notmuch-search-terms");
185 } else if (strcmp (argv[0], "hooks") == 0) {
186 exec_man ("notmuch-hooks");
190 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
195 /* Handle the case of "notmuch" being invoked with no command
196 * argument. For now we just call notmuch_setup_command, but we plan
197 * to be more clever about this in the future.
200 notmuch_command (notmuch_config_t *config,
201 unused(int argc), unused(char *argv[]))
206 /* If the user has never configured notmuch, then run
207 * notmuch_setup_command which will give a nice welcome message,
208 * and interactively guide the user through the configuration. */
209 if (notmuch_config_is_new (config))
210 return notmuch_setup_command (config, 0, NULL);
212 /* Notmuch is already configured, but is there a database? */
213 db_path = talloc_asprintf (config, "%s/%s",
214 notmuch_config_get_database_path (config),
216 if (stat (db_path, &st)) {
217 if (errno != ENOENT) {
218 fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
219 db_path, strerror (errno));
222 printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
224 printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
225 "Note that the first run of \"notmuch new\" can take a very long time\n"
226 "and that the resulting database will use roughly the same amount of\n"
227 "storage space as the email being indexed.\n\n");
231 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
232 "At this point you can start exploring the functionality of notmuch by\n"
233 "using commands such as:\n\n"
234 "\tnotmuch search tag:inbox\n\n"
235 "\tnotmuch search to:\"%s\"\n\n"
236 "\tnotmuch search from:\"%s\"\n\n"
237 "\tnotmuch search subject:\"my favorite things\"\n\n"
238 "See \"notmuch help search\" for more details.\n\n"
239 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
240 "from a search. Finally, you may want to explore using a more sophisticated\n"
241 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
242 "or any other interface described at http://notmuchmail.org\n\n"
243 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
244 "Have fun, and may your inbox never have much mail.\n\n",
245 notmuch_config_get_user_name (config),
246 notmuch_config_get_user_primary_email (config));
252 main (int argc, char *argv[])
256 const char *command_name = NULL;
258 char *config_file_name = NULL;
259 notmuch_config_t *config = NULL;
260 notmuch_bool_t print_help=FALSE, print_version=FALSE;
264 notmuch_opt_desc_t options[] = {
265 { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
266 { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
267 { NOTMUCH_OPT_STRING, &config_file_name, "config", 'c', 0 },
271 talloc_enable_null_tracking ();
273 local = talloc_new (NULL);
275 g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
276 #if !GLIB_CHECK_VERSION(2, 35, 1)
280 /* Globally default to the current output format version. */
281 notmuch_format_version = NOTMUCH_FORMAT_CUR;
283 opt_index = parse_arguments (argc, argv, options, 1);
290 ret = notmuch_help_command (NULL, argc - 1, &argv[1]);
295 printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
300 if (opt_index < argc)
301 command_name = argv[opt_index];
303 command = find_command (command_name);
305 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
311 config = notmuch_config_open (local, config_file_name, command->create_config);
317 ret = (command->function)(config, argc - opt_index, argv + opt_index);
321 notmuch_config_close (config);
323 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
324 if (talloc_report && strcmp (talloc_report, "") != 0) {
325 /* this relies on the previous call to
326 * talloc_enable_null_tracking
329 FILE *report = fopen (talloc_report, "w");
331 talloc_report_full (NULL, report);
334 fprintf (stderr, "ERROR: unable to write talloc log. ");
335 perror (talloc_report);