notmuch (0.27-2) unstable; urgency=medium
[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 https://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 /*
26  * Notmuch subcommand hook.
27  *
28  * The return value will be used as notmuch exit status code,
29  * preferably EXIT_SUCCESS or EXIT_FAILURE.
30  */
31 typedef int (*command_function_t) (notmuch_config_t *config, int argc, char *argv[]);
32
33 typedef struct command {
34     const char *name;
35     command_function_t function;
36     notmuch_config_mode_t config_mode;
37     const char *summary;
38 } command_t;
39
40 static int
41 notmuch_help_command (notmuch_config_t *config, int argc, char *argv[]);
42
43 static int
44 notmuch_command (notmuch_config_t *config, int argc, char *argv[]);
45
46 static int
47 _help_for (const char *topic);
48
49 static bool print_version = false, print_help = false;
50 const char *notmuch_requested_db_uuid = NULL;
51
52 const notmuch_opt_desc_t notmuch_shared_options [] = {
53     { .opt_bool = &print_version, .name = "version" },
54     { .opt_bool = &print_help, .name = "help" },
55     { .opt_string = &notmuch_requested_db_uuid, .name = "uuid" },
56     { }
57 };
58
59 /* any subcommand wanting to support these options should call
60  * inherit notmuch_shared_options and call
61  * notmuch_process_shared_options (subcommand_name);
62  */
63 void
64 notmuch_process_shared_options (const char *subcommand_name) {
65     if (print_version) {
66         printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
67         exit (EXIT_SUCCESS);
68     }
69
70     if (print_help) {
71         int ret = _help_for (subcommand_name);
72         exit (ret);
73     }
74 }
75
76 /* This is suitable for subcommands that do not actually open the
77  * database.
78  */
79 int notmuch_minimal_options (const char *subcommand_name,
80                                   int argc, char **argv)
81 {
82     int opt_index;
83
84     notmuch_opt_desc_t options[] = {
85         { .opt_inherit = notmuch_shared_options },
86         { }
87     };
88
89     opt_index = parse_arguments (argc, argv, options, 1);
90
91     if (opt_index < 0)
92         return -1;
93
94     /* We can't use argv here as it is sometimes NULL */
95     notmuch_process_shared_options (subcommand_name);
96     return opt_index;
97 }
98
99
100 struct _notmuch_client_indexing_cli_choices indexing_cli_choices = { };
101 const notmuch_opt_desc_t  notmuch_shared_indexing_options [] = {
102     { .opt_keyword = &indexing_cli_choices.decrypt_policy,
103       .present = &indexing_cli_choices.decrypt_policy_set, .keywords =
104       (notmuch_keyword_t []){ { "false", NOTMUCH_DECRYPT_FALSE },
105                               { "true", NOTMUCH_DECRYPT_TRUE },
106                               { "auto", NOTMUCH_DECRYPT_AUTO },
107                               { "nostash", NOTMUCH_DECRYPT_NOSTASH },
108                               { 0, 0 } },
109       .name = "decrypt" },
110     { }
111 };
112
113
114 notmuch_status_t
115 notmuch_process_shared_indexing_options (notmuch_database_t *notmuch, g_mime_3_unused(notmuch_config_t *config))
116 {
117     if (indexing_cli_choices.opts == NULL)
118         indexing_cli_choices.opts = notmuch_database_get_default_indexopts (notmuch);
119     if (indexing_cli_choices.decrypt_policy_set) {
120         notmuch_status_t status;
121         if (indexing_cli_choices.opts == NULL)
122             return NOTMUCH_STATUS_OUT_OF_MEMORY;
123         status = notmuch_indexopts_set_decrypt_policy (indexing_cli_choices.opts, indexing_cli_choices.decrypt_policy);
124         if (status != NOTMUCH_STATUS_SUCCESS) {
125             fprintf (stderr, "Error: Failed to set index decryption policy to %d. (%s)\n",
126                      indexing_cli_choices.decrypt_policy, notmuch_status_to_string (status));
127             notmuch_indexopts_destroy (indexing_cli_choices.opts);
128             indexing_cli_choices.opts = NULL;
129             return status;
130         }
131     }
132 #if (GMIME_MAJOR_VERSION < 3)
133     if (indexing_cli_choices.opts && notmuch_indexopts_get_decrypt_policy (indexing_cli_choices.opts) != NOTMUCH_DECRYPT_FALSE) {
134         const char* gpg_path = notmuch_config_get_crypto_gpg_path (config);
135         if (gpg_path && strcmp(gpg_path, "gpg"))
136             fprintf (stderr, "Warning: deprecated crypto.gpg_path is set to '%s'\n"
137                      "\tbut ignoring (use $PATH instead)\n", gpg_path);
138     }
139 #endif
140     return NOTMUCH_STATUS_SUCCESS;
141 }
142
143
144 static command_t commands[] = {
145     { NULL, notmuch_command, NOTMUCH_CONFIG_OPEN | NOTMUCH_CONFIG_CREATE,
146       "Notmuch main command." },
147     { "setup", notmuch_setup_command, NOTMUCH_CONFIG_OPEN | NOTMUCH_CONFIG_CREATE,
148       "Interactively set up notmuch for first use." },
149     { "new", notmuch_new_command, NOTMUCH_CONFIG_OPEN,
150       "Find and import new messages to the notmuch database." },
151     { "insert", notmuch_insert_command, NOTMUCH_CONFIG_OPEN,
152       "Add a new message into the maildir and notmuch database." },
153     { "search", notmuch_search_command, NOTMUCH_CONFIG_OPEN,
154       "Search for messages matching the given search terms." },
155     { "address", notmuch_address_command, NOTMUCH_CONFIG_OPEN,
156       "Get addresses from messages matching the given search terms." },
157     { "show", notmuch_show_command, NOTMUCH_CONFIG_OPEN,
158       "Show all messages matching the search terms." },
159     { "count", notmuch_count_command, NOTMUCH_CONFIG_OPEN,
160       "Count messages matching the search terms." },
161     { "reply", notmuch_reply_command, NOTMUCH_CONFIG_OPEN,
162       "Construct a reply template for a set of messages." },
163     { "tag", notmuch_tag_command, NOTMUCH_CONFIG_OPEN,
164       "Add/remove tags for all messages matching the search terms." },
165     { "dump", notmuch_dump_command, NOTMUCH_CONFIG_OPEN,
166       "Create a plain-text dump of the tags for each message." },
167     { "restore", notmuch_restore_command, NOTMUCH_CONFIG_OPEN,
168       "Restore the tags from the given dump file (see 'dump')." },
169     { "compact", notmuch_compact_command, NOTMUCH_CONFIG_OPEN,
170       "Compact the notmuch database." },
171     { "reindex", notmuch_reindex_command, NOTMUCH_CONFIG_OPEN,
172       "Re-index all messages matching the search terms." },
173     { "config", notmuch_config_command, NOTMUCH_CONFIG_OPEN,
174       "Get or set settings in the notmuch configuration file." },
175 #if WITH_EMACS
176     { "emacs-mua", NULL, 0,
177       "send mail with notmuch and emacs." },
178 #endif
179     { "help", notmuch_help_command, NOTMUCH_CONFIG_CREATE, /* create but don't save config */
180       "This message, or more detailed help for the named command." }
181 };
182
183 typedef struct help_topic {
184     const char *name;
185     const char *summary;
186 } help_topic_t;
187
188 static help_topic_t help_topics[] = {
189     { "search-terms",
190       "Common search term syntax." },
191     { "hooks",
192       "Hooks that will be run before or after certain commands." },
193     { "properties",
194       "Message property conventions and documentation." },
195 };
196
197 static command_t *
198 find_command (const char *name)
199 {
200     size_t i;
201
202     for (i = 0; i < ARRAY_SIZE (commands); i++)
203         if ((!name && !commands[i].name) ||
204             (name && commands[i].name && strcmp (name, commands[i].name) == 0))
205             return &commands[i];
206
207     return NULL;
208 }
209
210 int notmuch_format_version;
211
212 static void
213 usage (FILE *out)
214 {
215     command_t *command;
216     help_topic_t *topic;
217     unsigned int i;
218
219     fprintf (out,
220              "Usage: notmuch --help\n"
221              "       notmuch --version\n"
222              "       notmuch <command> [args...]\n");
223     fprintf (out, "\n");
224     fprintf (out, "The available commands are as follows:\n");
225     fprintf (out, "\n");
226
227     for (i = 0; i < ARRAY_SIZE (commands); i++) {
228         command = &commands[i];
229
230         if (command->name)
231             fprintf (out, "  %-12s  %s\n", command->name, command->summary);
232     }
233
234     fprintf (out, "\n");
235     fprintf (out, "Additional help topics are as follows:\n");
236     fprintf (out, "\n");
237
238     for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
239         topic = &help_topics[i];
240         fprintf (out, "  %-12s  %s\n", topic->name, topic->summary);
241     }
242
243     fprintf (out, "\n");
244     fprintf (out,
245              "Use \"notmuch help <command or topic>\" for more details "
246              "on each command or topic.\n\n");
247 }
248
249 void
250 notmuch_exit_if_unsupported_format (void)
251 {
252     if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
253         fprintf (stderr, "\
254 A caller requested output format version %d, but the installed notmuch\n\
255 CLI only supports up to format version %d.  You may need to upgrade your\n\
256 notmuch CLI.\n",
257                  notmuch_format_version, NOTMUCH_FORMAT_CUR);
258         exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
259     } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
260         fprintf (stderr, "\
261 A caller requested output format version %d, which is no longer supported\n\
262 by the notmuch CLI (it requires at least version %d).  You may need to\n\
263 upgrade your notmuch front-end.\n",
264                  notmuch_format_version, NOTMUCH_FORMAT_MIN);
265         exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
266     } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
267         /* Warn about old version requests so compatibility issues are
268          * less likely when we drop support for a deprecated format
269          * versions. */
270         fprintf (stderr, "\
271 A caller requested deprecated output format version %d, which may not\n\
272 be supported in the future.\n", notmuch_format_version);
273     }
274 }
275
276 void
277 notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
278 {
279     const char *uuid = NULL;
280
281     if (!notmuch_requested_db_uuid)
282         return;
283     IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));
284
285     if (strcmp (notmuch_requested_db_uuid, uuid) != 0){
286         fprintf (stderr, "Error: requested database revision %s does not match %s\n",
287                  notmuch_requested_db_uuid, uuid);
288         exit (1);
289     }
290 }
291
292 static void
293 exec_man (const char *page)
294 {
295     if (execlp ("man", "man", page, (char *) NULL)) {
296         perror ("exec man");
297         exit (1);
298     }
299 }
300
301 static int
302 _help_for (const char *topic_name)
303 {
304     command_t *command;
305     help_topic_t *topic;
306     unsigned int i;
307
308     if (!topic_name) {
309         printf ("The notmuch mail system.\n\n");
310         usage (stdout);
311         return EXIT_SUCCESS;
312     }
313
314     if (strcmp (topic_name, "help") == 0) {
315         printf ("The notmuch help system.\n\n"
316                 "\tNotmuch uses the man command to display help. In case\n"
317                 "\tof difficulties check that MANPATH includes the pages\n"
318                 "\tinstalled by notmuch.\n\n"
319                 "\tTry \"notmuch help\" for a list of topics.\n");
320         return EXIT_SUCCESS;
321     }
322
323     command = find_command (topic_name);
324     if (command) {
325         char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
326         exec_man (page);
327     }
328
329     for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
330         topic = &help_topics[i];
331         if (strcmp (topic_name, topic->name) == 0) {
332             char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);
333             exec_man (page);
334         }
335     }
336
337     fprintf (stderr,
338              "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
339              topic_name);
340     return EXIT_FAILURE;
341 }
342
343 static int
344 notmuch_help_command (unused (notmuch_config_t * config), int argc, char *argv[])
345 {
346     int opt_index;
347
348     opt_index = notmuch_minimal_options ("help", argc, argv);
349     if (opt_index < 0)
350         return EXIT_FAILURE;
351
352     /* skip at least subcommand argument */
353     argc-= opt_index;
354     argv+= opt_index;
355
356     if (argc == 0) {
357         return _help_for (NULL);
358     }
359
360     return _help_for (argv[0]);
361 }
362
363 /* Handle the case of "notmuch" being invoked with no command
364  * argument. For now we just call notmuch_setup_command, but we plan
365  * to be more clever about this in the future.
366  */
367 static int
368 notmuch_command (notmuch_config_t *config,
369                  unused(int argc), unused(char *argv[]))
370 {
371     char *db_path;
372     struct stat st;
373
374     /* If the user has never configured notmuch, then run
375      * notmuch_setup_command which will give a nice welcome message,
376      * and interactively guide the user through the configuration. */
377     if (notmuch_config_is_new (config))
378         return notmuch_setup_command (config, 0, NULL);
379
380     /* Notmuch is already configured, but is there a database? */
381     db_path = talloc_asprintf (config, "%s/%s",
382                                notmuch_config_get_database_path (config),
383                                ".notmuch");
384     if (stat (db_path, &st)) {
385         if (errno != ENOENT) {
386             fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
387                      db_path, strerror (errno));
388             return EXIT_FAILURE;
389         }
390         printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
391                 db_path);
392         printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
393                 "Note that the first run of \"notmuch new\" can take a very long time\n"
394                 "and that the resulting database will use roughly the same amount of\n"
395                 "storage space as the email being indexed.\n\n");
396         return EXIT_SUCCESS;
397     }
398
399     printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
400             "At this point you can start exploring the functionality of notmuch by\n"
401             "using commands such as:\n\n"
402             "\tnotmuch search tag:inbox\n\n"
403             "\tnotmuch search to:\"%s\"\n\n"
404             "\tnotmuch search from:\"%s\"\n\n"
405             "\tnotmuch search subject:\"my favorite things\"\n\n"
406             "See \"notmuch help search\" for more details.\n\n"
407             "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
408             "from a search. Finally, you may want to explore using a more sophisticated\n"
409             "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
410             "or any other interface described at https://notmuchmail.org\n\n"
411             "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
412             "Have fun, and may your inbox never have much mail.\n\n",
413             notmuch_config_get_user_name (config),
414             notmuch_config_get_user_primary_email (config));
415
416     return EXIT_SUCCESS;
417 }
418
419 /*
420  * Try to run subcommand in argv[0] as notmuch- prefixed external
421  * command. argv must be NULL terminated (argv passed to main always
422  * is).
423  *
424  * Does not return if the external command is found and
425  * executed. Return true if external command is not found. Return
426  * false on errors.
427  */
428 static bool try_external_command(char *argv[])
429 {
430     char *old_argv0 = argv[0];
431     bool ret = true;
432
433     argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);
434
435     /*
436      * This will only return on errors. Not finding an external
437      * command (ENOENT) is not an error from our perspective.
438      */
439     execvp (argv[0], argv);
440     if (errno != ENOENT) {
441         fprintf (stderr, "Error: Running external command '%s' failed: %s\n",
442                  argv[0], strerror(errno));
443         ret = false;
444     }
445
446     talloc_free (argv[0]);
447     argv[0] = old_argv0;
448
449     return ret;
450 }
451
452 int
453 main (int argc, char *argv[])
454 {
455     void *local;
456     char *talloc_report;
457     const char *command_name = NULL;
458     command_t *command;
459     const char *config_file_name = NULL;
460     notmuch_config_t *config = NULL;
461     int opt_index;
462     int ret;
463
464     notmuch_opt_desc_t options[] = {
465         { .opt_string = &config_file_name, .name = "config" },
466         { .opt_inherit = notmuch_shared_options },
467         { }
468     };
469
470     talloc_enable_null_tracking ();
471
472     local = talloc_new (NULL);
473
474     g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
475 #if !GLIB_CHECK_VERSION(2, 35, 1)
476     g_type_init ();
477 #endif
478
479     /* Globally default to the current output format version. */
480     notmuch_format_version = NOTMUCH_FORMAT_CUR;
481
482     opt_index = parse_arguments (argc, argv, options, 1);
483     if (opt_index < 0) {
484         ret = EXIT_FAILURE;
485         goto DONE;
486     }
487
488     if (opt_index < argc)
489         command_name = argv[opt_index];
490
491     notmuch_process_shared_options (command_name);
492
493     command = find_command (command_name);
494     /* if command->function is NULL, try external command */
495     if (!command || !command->function) {
496         /* This won't return if the external command is found. */
497         if (try_external_command(argv + opt_index))
498             fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
499                      command_name);
500         ret = EXIT_FAILURE;
501         goto DONE;
502     }
503
504     config = notmuch_config_open (local, config_file_name, command->config_mode);
505     if (!config) {
506         ret = EXIT_FAILURE;
507         goto DONE;
508     }
509
510     ret = (command->function)(config, argc - opt_index, argv + opt_index);
511
512   DONE:
513     if (config)
514         notmuch_config_close (config);
515
516     talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
517     if (talloc_report && strcmp (talloc_report, "") != 0) {
518         /* this relies on the previous call to
519          * talloc_enable_null_tracking
520          */
521
522         FILE *report = fopen (talloc_report, "w");
523         if (report) {
524             talloc_report_full (NULL, report);
525         } else {
526             ret = 1;
527             fprintf (stderr, "ERROR: unable to write talloc log. ");
528             perror (talloc_report);
529         }
530     }
531
532     talloc_free (local);
533
534     return ret;
535 }