54f46c6828cc13a72d6dec17cc264e50b4e9c231
[notmuch] / notmuch.c
1 /* notmuch - Not much of an email program, (just index and search)
2  *
3  * Copyright © 2009 Carl Worth
4  * Copyright © 2009 Keith Packard
5  *
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.
10  *
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.
15  *
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/ .
18  *
19  * Authors: Carl Worth <cworth@cworth.org>
20  *          Keith Packard <keithp@keithp.com>
21  */
22
23 #include "notmuch-client.h"
24
25 typedef int (*command_function_t) (notmuch_config_t *config, int argc, char *argv[]);
26
27 typedef struct command {
28     const char *name;
29     command_function_t function;
30     notmuch_bool_t create_config;
31     const char *summary;
32 } command_t;
33
34 static int
35 notmuch_help_command (notmuch_config_t *config, int argc, char *argv[]);
36
37 static int
38 notmuch_command (notmuch_config_t *config, int argc, char *argv[]);
39
40 static command_t commands[] = {
41     { NULL, notmuch_command, TRUE,
42       "Notmuch main command." },
43     { "setup", notmuch_setup_command, TRUE,
44       "Interactively setup notmuch for first use." },
45     { "new", notmuch_new_command, FALSE,
46       "Find and import new messages to the notmuch database." },
47     { "insert", notmuch_insert_command, FALSE,
48       "Add a new message into the maildir and notmuch database." },
49     { "search", notmuch_search_command, FALSE,
50       "Search for messages matching the given search terms." },
51     { "show", notmuch_show_command, FALSE,
52       "Show all messages matching the search terms." },
53     { "count", notmuch_count_command, FALSE,
54       "Count messages matching the search terms." },
55     { "reply", notmuch_reply_command, FALSE,
56       "Construct a reply template for a set of messages." },
57     { "tag", notmuch_tag_command, FALSE,
58       "Add/remove tags for all messages matching the search terms." },
59     { "dump", notmuch_dump_command, FALSE,
60       "Create a plain-text dump of the tags for each message." },
61     { "restore", notmuch_restore_command, FALSE,
62       "Restore the tags from the given dump file (see 'dump')." },
63     { "compact", notmuch_compact_command, FALSE,
64       "Compact the notmuch database." },
65     { "config", notmuch_config_command, FALSE,
66       "Get or set settings in the notmuch configuration file." },
67     { "help", notmuch_help_command, TRUE, /* create but don't save config */
68       "This message, or more detailed help for the named command." }
69 };
70
71 static command_t *
72 find_command (const char *name)
73 {
74     size_t i;
75
76     for (i = 0; i < ARRAY_SIZE (commands); i++)
77         if ((!name && !commands[i].name) ||
78             (name && commands[i].name && strcmp (name, commands[i].name) == 0))
79             return &commands[i];
80
81     return NULL;
82 }
83
84 int notmuch_format_version;
85
86 static void
87 usage (FILE *out)
88 {
89     command_t *command;
90     unsigned int i;
91
92     fprintf (out,
93              "Usage: notmuch --help\n"
94              "       notmuch --version\n"
95              "       notmuch <command> [args...]\n");
96     fprintf (out, "\n");
97     fprintf (out, "The available commands are as follows:\n");
98     fprintf (out, "\n");
99
100     for (i = 0; i < ARRAY_SIZE (commands); i++) {
101         command = &commands[i];
102
103         if (command->name)
104             fprintf (out, "  %-11s  %s\n", command->name, command->summary);
105     }
106
107     fprintf (out, "\n");
108     fprintf (out,
109     "Use \"notmuch help <command>\" for more details on each command\n"
110     "and \"notmuch help search-terms\" for the common search-terms syntax.\n\n");
111 }
112
113 void
114 notmuch_exit_if_unsupported_format (void)
115 {
116     if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
117         fprintf (stderr, "\
118 A caller requested output format version %d, but the installed notmuch\n\
119 CLI only supports up to format version %d.  You may need to upgrade your\n\
120 notmuch CLI.\n",
121                  notmuch_format_version, NOTMUCH_FORMAT_CUR);
122         exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
123     } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
124         fprintf (stderr, "\
125 A caller requested output format version %d, which is no longer supported\n\
126 by the notmuch CLI (it requires at least version %d).  You may need to\n\
127 upgrade your notmuch front-end.\n",
128                  notmuch_format_version, NOTMUCH_FORMAT_MIN);
129         exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
130     } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
131         /* Warn about old version requests so compatibility issues are
132          * less likely when we drop support for a deprecated format
133          * versions. */
134         fprintf (stderr, "\
135 A caller requested deprecated output format version %d, which may not\n\
136 be supported in the future.\n", notmuch_format_version);
137     }
138 }
139
140 static void
141 exec_man (const char *page)
142 {
143     if (execlp ("man", "man", page, (char *) NULL)) {
144         perror ("exec man");
145         exit (1);
146     }
147 }
148
149 static int
150 notmuch_help_command (notmuch_config_t *config, int argc, char *argv[])
151 {
152     command_t *command;
153
154     argc--; argv++; /* Ignore "help" */
155
156     if (argc == 0) {
157         printf ("The notmuch mail system.\n\n");
158         usage (stdout);
159         return 0;
160     }
161
162     if (strcmp (argv[0], "help") == 0) {
163         printf ("The notmuch help system.\n\n"
164                 "\tNotmuch uses the man command to display help. In case\n"
165                 "\tof difficulties check that MANPATH includes the pages\n"
166                 "\tinstalled by notmuch.\n\n"
167                 "\tTry \"notmuch help\" for a list of topics.\n");
168         return 0;
169     }
170
171     command = find_command (argv[0]);
172     if (command) {
173         char *page = talloc_asprintf (config, "notmuch-%s", command->name);
174         exec_man (page);
175     }
176
177     if (strcmp (argv[0], "search-terms") == 0) {
178         exec_man ("notmuch-search-terms");
179     } else if (strcmp (argv[0], "hooks") == 0) {
180         exec_man ("notmuch-hooks");
181     }
182
183     fprintf (stderr,
184              "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
185              argv[0]);
186     return 1;
187 }
188
189 /* Handle the case of "notmuch" being invoked with no command
190  * argument. For now we just call notmuch_setup_command, but we plan
191  * to be more clever about this in the future.
192  */
193 static int
194 notmuch_command (notmuch_config_t *config,
195                  unused(int argc), unused(char *argv[]))
196 {
197     char *db_path;
198     struct stat st;
199
200     /* If the user has never configured notmuch, then run
201      * notmuch_setup_command which will give a nice welcome message,
202      * and interactively guide the user through the configuration. */
203     if (notmuch_config_is_new (config))
204         return notmuch_setup_command (config, 0, NULL);
205
206     /* Notmuch is already configured, but is there a database? */
207     db_path = talloc_asprintf (config, "%s/%s",
208                                notmuch_config_get_database_path (config),
209                                ".notmuch");
210     if (stat (db_path, &st)) {
211         if (errno != ENOENT) {
212             fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
213                      db_path, strerror (errno));
214             return 1;
215         }
216         printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
217                 db_path);
218         printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
219                 "Note that the first run of \"notmuch new\" can take a very long time\n"
220                 "and that the resulting database will use roughly the same amount of\n"
221                 "storage space as the email being indexed.\n\n");
222         return 0;
223     }
224
225     printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
226             "At this point you can start exploring the functionality of notmuch by\n"
227             "using commands such as:\n\n"
228             "\tnotmuch search tag:inbox\n\n"
229             "\tnotmuch search to:\"%s\"\n\n"
230             "\tnotmuch search from:\"%s\"\n\n"
231             "\tnotmuch search subject:\"my favorite things\"\n\n"
232             "See \"notmuch help search\" for more details.\n\n"
233             "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
234             "from a search. Finally, you may want to explore using a more sophisticated\n"
235             "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
236             "or any other interface described at http://notmuchmail.org\n\n"
237             "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
238             "Have fun, and may your inbox never have much mail.\n\n",
239             notmuch_config_get_user_name (config),
240             notmuch_config_get_user_primary_email (config));
241
242     return 0;
243 }
244
245 int
246 main (int argc, char *argv[])
247 {
248     void *local;
249     char *talloc_report;
250     const char *command_name = NULL;
251     command_t *command;
252     char *config_file_name = NULL;
253     notmuch_config_t *config;
254     notmuch_bool_t print_help=FALSE, print_version=FALSE;
255     int opt_index;
256     int ret = 0;
257
258     notmuch_opt_desc_t options[] = {
259         { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
260         { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
261         { NOTMUCH_OPT_STRING, &config_file_name, "config", 'c', 0 },
262         { 0, 0, 0, 0, 0 }
263     };
264
265     talloc_enable_null_tracking ();
266
267     local = talloc_new (NULL);
268
269     g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
270 #if !GLIB_CHECK_VERSION(2, 35, 1)
271     g_type_init ();
272 #endif
273
274     /* Globally default to the current output format version. */
275     notmuch_format_version = NOTMUCH_FORMAT_CUR;
276
277     opt_index = parse_arguments (argc, argv, options, 1);
278     if (opt_index < 0) {
279         /* diagnostics already printed */
280         return 1;
281     }
282
283     if (print_help)
284         return notmuch_help_command (NULL, argc - 1, &argv[1]);
285
286     if (print_version) {
287         printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
288         return 0;
289     }
290
291     if (opt_index < argc)
292         command_name = argv[opt_index];
293
294     command = find_command (command_name);
295     if (!command) {
296         fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
297                  command_name);
298         return 1;
299     }
300
301     config = notmuch_config_open (local, config_file_name, command->create_config);
302     if (!config)
303         return 1;
304
305     ret = (command->function)(config, argc - opt_index, argv + opt_index);
306
307     notmuch_config_close (config);
308
309     talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
310     if (talloc_report && strcmp (talloc_report, "") != 0) {
311         /* this relies on the previous call to
312          * talloc_enable_null_tracking
313          */
314
315         FILE *report = fopen (talloc_report, "w");
316         if (report) {
317             talloc_report_full (NULL, report);
318         } else {
319             ret = 1;
320             fprintf (stderr, "ERROR: unable to write talloc log. ");
321             perror (talloc_report);
322         }
323     }
324
325     talloc_free (local);
326
327     return ret;
328 }