]> git.cworth.org Git - notmuch-old/blob - notmuch.c
0becd87e7841e739c8ddf2094bb5b942518b75f5
[notmuch-old] / 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  * preferrably 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 };
194
195 static command_t *
196 find_command (const char *name)
197 {
198     size_t i;
199
200     for (i = 0; i < ARRAY_SIZE (commands); i++)
201         if ((!name && !commands[i].name) ||
202             (name && commands[i].name && strcmp (name, commands[i].name) == 0))
203             return &commands[i];
204
205     return NULL;
206 }
207
208 int notmuch_format_version;
209
210 static void
211 usage (FILE *out)
212 {
213     command_t *command;
214     help_topic_t *topic;
215     unsigned int i;
216
217     fprintf (out,
218              "Usage: notmuch --help\n"
219              "       notmuch --version\n"
220              "       notmuch <command> [args...]\n");
221     fprintf (out, "\n");
222     fprintf (out, "The available commands are as follows:\n");
223     fprintf (out, "\n");
224
225     for (i = 0; i < ARRAY_SIZE (commands); i++) {
226         command = &commands[i];
227
228         if (command->name)
229             fprintf (out, "  %-12s  %s\n", command->name, command->summary);
230     }
231
232     fprintf (out, "\n");
233     fprintf (out, "Additional help topics are as follows:\n");
234     fprintf (out, "\n");
235
236     for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
237         topic = &help_topics[i];
238         fprintf (out, "  %-12s  %s\n", topic->name, topic->summary);
239     }
240
241     fprintf (out, "\n");
242     fprintf (out,
243              "Use \"notmuch help <command or topic>\" for more details "
244              "on each command or topic.\n\n");
245 }
246
247 void
248 notmuch_exit_if_unsupported_format (void)
249 {
250     if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
251         fprintf (stderr, "\
252 A caller requested output format version %d, but the installed notmuch\n\
253 CLI only supports up to format version %d.  You may need to upgrade your\n\
254 notmuch CLI.\n",
255                  notmuch_format_version, NOTMUCH_FORMAT_CUR);
256         exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
257     } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
258         fprintf (stderr, "\
259 A caller requested output format version %d, which is no longer supported\n\
260 by the notmuch CLI (it requires at least version %d).  You may need to\n\
261 upgrade your notmuch front-end.\n",
262                  notmuch_format_version, NOTMUCH_FORMAT_MIN);
263         exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
264     } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
265         /* Warn about old version requests so compatibility issues are
266          * less likely when we drop support for a deprecated format
267          * versions. */
268         fprintf (stderr, "\
269 A caller requested deprecated output format version %d, which may not\n\
270 be supported in the future.\n", notmuch_format_version);
271     }
272 }
273
274 void
275 notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
276 {
277     const char *uuid = NULL;
278
279     if (!notmuch_requested_db_uuid)
280         return;
281     IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));
282
283     if (strcmp (notmuch_requested_db_uuid, uuid) != 0){
284         fprintf (stderr, "Error: requested database revision %s does not match %s\n",
285                  notmuch_requested_db_uuid, uuid);
286         exit (1);
287     }
288 }
289
290 static void
291 exec_man (const char *page)
292 {
293     if (execlp ("man", "man", page, (char *) NULL)) {
294         perror ("exec man");
295         exit (1);
296     }
297 }
298
299 static int
300 _help_for (const char *topic_name)
301 {
302     command_t *command;
303     help_topic_t *topic;
304     unsigned int i;
305
306     if (!topic_name) {
307         printf ("The notmuch mail system.\n\n");
308         usage (stdout);
309         return EXIT_SUCCESS;
310     }
311
312     if (strcmp (topic_name, "help") == 0) {
313         printf ("The notmuch help system.\n\n"
314                 "\tNotmuch uses the man command to display help. In case\n"
315                 "\tof difficulties check that MANPATH includes the pages\n"
316                 "\tinstalled by notmuch.\n\n"
317                 "\tTry \"notmuch help\" for a list of topics.\n");
318         return EXIT_SUCCESS;
319     }
320
321     command = find_command (topic_name);
322     if (command) {
323         char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);
324         exec_man (page);
325     }
326
327     for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
328         topic = &help_topics[i];
329         if (strcmp (topic_name, topic->name) == 0) {
330             char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);
331             exec_man (page);
332         }
333     }
334
335     fprintf (stderr,
336              "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
337              topic_name);
338     return EXIT_FAILURE;
339 }
340
341 static int
342 notmuch_help_command (unused (notmuch_config_t * config), int argc, char *argv[])
343 {
344     int opt_index;
345
346     opt_index = notmuch_minimal_options ("help", argc, argv);
347     if (opt_index < 0)
348         return EXIT_FAILURE;
349
350     /* skip at least subcommand argument */
351     argc-= opt_index;
352     argv+= opt_index;
353
354     if (argc == 0) {
355         return _help_for (NULL);
356     }
357
358     return _help_for (argv[0]);
359 }
360
361 /* Handle the case of "notmuch" being invoked with no command
362  * argument. For now we just call notmuch_setup_command, but we plan
363  * to be more clever about this in the future.
364  */
365 static int
366 notmuch_command (notmuch_config_t *config,
367                  unused(int argc), unused(char *argv[]))
368 {
369     char *db_path;
370     struct stat st;
371
372     /* If the user has never configured notmuch, then run
373      * notmuch_setup_command which will give a nice welcome message,
374      * and interactively guide the user through the configuration. */
375     if (notmuch_config_is_new (config))
376         return notmuch_setup_command (config, 0, NULL);
377
378     /* Notmuch is already configured, but is there a database? */
379     db_path = talloc_asprintf (config, "%s/%s",
380                                notmuch_config_get_database_path (config),
381                                ".notmuch");
382     if (stat (db_path, &st)) {
383         if (errno != ENOENT) {
384             fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
385                      db_path, strerror (errno));
386             return EXIT_FAILURE;
387         }
388         printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
389                 db_path);
390         printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
391                 "Note that the first run of \"notmuch new\" can take a very long time\n"
392                 "and that the resulting database will use roughly the same amount of\n"
393                 "storage space as the email being indexed.\n\n");
394         return EXIT_SUCCESS;
395     }
396
397     printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
398             "At this point you can start exploring the functionality of notmuch by\n"
399             "using commands such as:\n\n"
400             "\tnotmuch search tag:inbox\n\n"
401             "\tnotmuch search to:\"%s\"\n\n"
402             "\tnotmuch search from:\"%s\"\n\n"
403             "\tnotmuch search subject:\"my favorite things\"\n\n"
404             "See \"notmuch help search\" for more details.\n\n"
405             "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
406             "from a search. Finally, you may want to explore using a more sophisticated\n"
407             "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
408             "or any other interface described at https://notmuchmail.org\n\n"
409             "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
410             "Have fun, and may your inbox never have much mail.\n\n",
411             notmuch_config_get_user_name (config),
412             notmuch_config_get_user_primary_email (config));
413
414     return EXIT_SUCCESS;
415 }
416
417 /*
418  * Try to run subcommand in argv[0] as notmuch- prefixed external
419  * command. argv must be NULL terminated (argv passed to main always
420  * is).
421  *
422  * Does not return if the external command is found and
423  * executed. Return true if external command is not found. Return
424  * false on errors.
425  */
426 static bool try_external_command(char *argv[])
427 {
428     char *old_argv0 = argv[0];
429     bool ret = true;
430
431     argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);
432
433     /*
434      * This will only return on errors. Not finding an external
435      * command (ENOENT) is not an error from our perspective.
436      */
437     execvp (argv[0], argv);
438     if (errno != ENOENT) {
439         fprintf (stderr, "Error: Running external command '%s' failed: %s\n",
440                  argv[0], strerror(errno));
441         ret = false;
442     }
443
444     talloc_free (argv[0]);
445     argv[0] = old_argv0;
446
447     return ret;
448 }
449
450 int
451 main (int argc, char *argv[])
452 {
453     void *local;
454     char *talloc_report;
455     const char *command_name = NULL;
456     command_t *command;
457     const char *config_file_name = NULL;
458     notmuch_config_t *config = NULL;
459     int opt_index;
460     int ret;
461
462     notmuch_opt_desc_t options[] = {
463         { .opt_string = &config_file_name, .name = "config" },
464         { .opt_inherit = notmuch_shared_options },
465         { }
466     };
467
468     talloc_enable_null_tracking ();
469
470     local = talloc_new (NULL);
471
472     g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
473 #if !GLIB_CHECK_VERSION(2, 35, 1)
474     g_type_init ();
475 #endif
476
477     /* Globally default to the current output format version. */
478     notmuch_format_version = NOTMUCH_FORMAT_CUR;
479
480     opt_index = parse_arguments (argc, argv, options, 1);
481     if (opt_index < 0) {
482         ret = EXIT_FAILURE;
483         goto DONE;
484     }
485
486     if (opt_index < argc)
487         command_name = argv[opt_index];
488
489     notmuch_process_shared_options (command_name);
490
491     command = find_command (command_name);
492     /* if command->function is NULL, try external command */
493     if (!command || !command->function) {
494         /* This won't return if the external command is found. */
495         if (try_external_command(argv + opt_index))
496             fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
497                      command_name);
498         ret = EXIT_FAILURE;
499         goto DONE;
500     }
501
502     config = notmuch_config_open (local, config_file_name, command->config_mode);
503     if (!config) {
504         ret = EXIT_FAILURE;
505         goto DONE;
506     }
507
508     ret = (command->function)(config, argc - opt_index, argv + opt_index);
509
510   DONE:
511     if (config)
512         notmuch_config_close (config);
513
514     talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
515     if (talloc_report && strcmp (talloc_report, "") != 0) {
516         /* this relies on the previous call to
517          * talloc_enable_null_tracking
518          */
519
520         FILE *report = fopen (talloc_report, "w");
521         if (report) {
522             talloc_report_full (NULL, report);
523         } else {
524             ret = 1;
525             fprintf (stderr, "ERROR: unable to write talloc log. ");
526             perror (talloc_report);
527         }
528     }
529
530     talloc_free (local);
531
532     return ret;
533 }