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[]);
47 _help_for (const char *topic);
49 static notmuch_bool_t print_version = FALSE, print_help = FALSE;
51 const notmuch_opt_desc_t notmuch_shared_options [] = {
52 { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
53 { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
57 /* any subcommand wanting to support these options should call
58 * inherit notmuch_shared_options and call
59 * notmuch_process_shared_options (subcommand_name);
62 notmuch_process_shared_options (const char *subcommand_name) {
64 printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
69 int ret = _help_for (subcommand_name);
75 static command_t commands[] = {
76 { NULL, notmuch_command, TRUE,
77 "Notmuch main command." },
78 { "setup", notmuch_setup_command, TRUE,
79 "Interactively set up notmuch for first use." },
80 { "new", notmuch_new_command, FALSE,
81 "Find and import new messages to the notmuch database." },
82 { "insert", notmuch_insert_command, FALSE,
83 "Add a new message into the maildir and notmuch database." },
84 { "search", notmuch_search_command, FALSE,
85 "Search for messages matching the given search terms." },
86 { "address", notmuch_address_command, FALSE,
87 "Get addresses from messages matching the given search terms." },
88 { "show", notmuch_show_command, FALSE,
89 "Show all messages matching the search terms." },
90 { "count", notmuch_count_command, FALSE,
91 "Count messages matching the search terms." },
92 { "reply", notmuch_reply_command, FALSE,
93 "Construct a reply template for a set of messages." },
94 { "tag", notmuch_tag_command, FALSE,
95 "Add/remove tags for all messages matching the search terms." },
96 { "dump", notmuch_dump_command, FALSE,
97 "Create a plain-text dump of the tags for each message." },
98 { "restore", notmuch_restore_command, FALSE,
99 "Restore the tags from the given dump file (see 'dump')." },
100 { "compact", notmuch_compact_command, FALSE,
101 "Compact the notmuch database." },
102 { "config", notmuch_config_command, FALSE,
103 "Get or set settings in the notmuch configuration file." },
104 { "help", notmuch_help_command, TRUE, /* create but don't save config */
105 "This message, or more detailed help for the named command." }
108 typedef struct help_topic {
113 static help_topic_t help_topics[] = {
115 "Common search term syntax." },
117 "Hooks that will be run before or after certain commands." },
121 find_command (const char *name)
125 for (i = 0; i < ARRAY_SIZE (commands); i++)
126 if ((!name && !commands[i].name) ||
127 (name && commands[i].name && strcmp (name, commands[i].name) == 0))
133 int notmuch_format_version;
143 "Usage: notmuch --help\n"
144 " notmuch --version\n"
145 " notmuch <command> [args...]\n");
147 fprintf (out, "The available commands are as follows:\n");
150 for (i = 0; i < ARRAY_SIZE (commands); i++) {
151 command = &commands[i];
154 fprintf (out, " %-12s %s\n", command->name, command->summary);
158 fprintf (out, "Additional help topics are as follows:\n");
161 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
162 topic = &help_topics[i];
163 fprintf (out, " %-12s %s\n", topic->name, topic->summary);
168 "Use \"notmuch help <command or topic>\" for more details "
169 "on each command or topic.\n\n");
173 notmuch_exit_if_unsupported_format (void)
175 if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
177 A caller requested output format version %d, but the installed notmuch\n\
178 CLI only supports up to format version %d. You may need to upgrade your\n\
180 notmuch_format_version, NOTMUCH_FORMAT_CUR);
181 exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
182 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
184 A caller requested output format version %d, which is no longer supported\n\
185 by the notmuch CLI (it requires at least version %d). You may need to\n\
186 upgrade your notmuch front-end.\n",
187 notmuch_format_version, NOTMUCH_FORMAT_MIN);
188 exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
189 } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
190 /* Warn about old version requests so compatibility issues are
191 * less likely when we drop support for a deprecated format
194 A caller requested deprecated output format version %d, which may not\n\
195 be supported in the future.\n", notmuch_format_version);
200 exec_man (const char *page)
202 if (execlp ("man", "man", page, (char *) NULL)) {
209 _help_for (const char *topic_name)
216 printf ("The notmuch mail system.\n\n");
221 if (strcmp (topic_name, "help") == 0) {
222 printf ("The notmuch help system.\n\n"
223 "\tNotmuch uses the man command to display help. In case\n"
224 "\tof difficulties check that MANPATH includes the pages\n"
225 "\tinstalled by notmuch.\n\n"
226 "\tTry \"notmuch help\" for a list of topics.\n");
230 command = find_command (topic_name);
232 char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
236 for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
237 topic = &help_topics[i];
238 if (strcmp (topic_name, topic->name) == 0) {
239 char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);
245 "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
251 notmuch_help_command (unused (notmuch_config_t * config), int argc, char *argv[])
253 argc--; argv++; /* Ignore "help" */
256 return _help_for (NULL);
259 return _help_for (argv[0]);
262 /* Handle the case of "notmuch" being invoked with no command
263 * argument. For now we just call notmuch_setup_command, but we plan
264 * to be more clever about this in the future.
267 notmuch_command (notmuch_config_t *config,
268 unused(int argc), unused(char *argv[]))
273 /* If the user has never configured notmuch, then run
274 * notmuch_setup_command which will give a nice welcome message,
275 * and interactively guide the user through the configuration. */
276 if (notmuch_config_is_new (config))
277 return notmuch_setup_command (config, 0, NULL);
279 /* Notmuch is already configured, but is there a database? */
280 db_path = talloc_asprintf (config, "%s/%s",
281 notmuch_config_get_database_path (config),
283 if (stat (db_path, &st)) {
284 if (errno != ENOENT) {
285 fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
286 db_path, strerror (errno));
289 printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
291 printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
292 "Note that the first run of \"notmuch new\" can take a very long time\n"
293 "and that the resulting database will use roughly the same amount of\n"
294 "storage space as the email being indexed.\n\n");
298 printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
299 "At this point you can start exploring the functionality of notmuch by\n"
300 "using commands such as:\n\n"
301 "\tnotmuch search tag:inbox\n\n"
302 "\tnotmuch search to:\"%s\"\n\n"
303 "\tnotmuch search from:\"%s\"\n\n"
304 "\tnotmuch search subject:\"my favorite things\"\n\n"
305 "See \"notmuch help search\" for more details.\n\n"
306 "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
307 "from a search. Finally, you may want to explore using a more sophisticated\n"
308 "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
309 "or any other interface described at http://notmuchmail.org\n\n"
310 "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
311 "Have fun, and may your inbox never have much mail.\n\n",
312 notmuch_config_get_user_name (config),
313 notmuch_config_get_user_primary_email (config));
319 main (int argc, char *argv[])
323 const char *command_name = NULL;
325 char *config_file_name = NULL;
326 notmuch_config_t *config = NULL;
330 notmuch_opt_desc_t options[] = {
331 { NOTMUCH_OPT_STRING, &config_file_name, "config", 'c', 0 },
332 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
336 talloc_enable_null_tracking ();
338 local = talloc_new (NULL);
340 g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
341 #if !GLIB_CHECK_VERSION(2, 35, 1)
345 /* Globally default to the current output format version. */
346 notmuch_format_version = NOTMUCH_FORMAT_CUR;
348 opt_index = parse_arguments (argc, argv, options, 1);
354 notmuch_process_shared_options (NULL);
356 if (opt_index < argc)
357 command_name = argv[opt_index];
359 command = find_command (command_name);
361 fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
367 config = notmuch_config_open (local, config_file_name, command->create_config);
373 ret = (command->function)(config, argc - opt_index, argv + opt_index);
377 notmuch_config_close (config);
379 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
380 if (talloc_report && strcmp (talloc_report, "") != 0) {
381 /* this relies on the previous call to
382 * talloc_enable_null_tracking
385 FILE *report = fopen (talloc_report, "w");
387 talloc_report_full (NULL, report);
390 fprintf (stderr, "ERROR: unable to write talloc log. ");
391 perror (talloc_report);