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