cli/help: give a hint about notmuch-emacs-mua

[notmuch] / notmuch.c

diff --git a/notmuch.c b/notmuch.c
index dcda0392a0945123f735399f72308c8653a3b1f4..fa866d8645ee72ee00f7bc410a2a239e653f53f4 100644 (file)
--- a/notmuch.c
+++ b/notmuch.c
@@ -14,7 +14,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License

- * along with this program.  If not, see http://www.gnu.org/licenses/ .
+ * along with this program.  If not, see https://www.gnu.org/licenses/ .

  *
  * Authors: Carl Worth <cworth@cworth.org>
  *         Keith Packard <keithp@keithp.com>
  *
  * Authors: Carl Worth <cworth@cworth.org>
  *         Keith Packard <keithp@keithp.com>


@@ -33,7 +33,7 @@ typedef int (*command_function_t) (notmuch_config_t *config, int argc, char *arg
 typedef struct command {
     const char *name;
     command_function_t function;
 typedef struct command {
     const char *name;
     command_function_t function;

-    notmuch_bool_t create_config;
+    notmuch_config_mode_t config_mode;

     const char *summary;
 } command_t;
 
     const char *summary;
 } command_t;
 


@@ -43,34 +43,135 @@ notmuch_help_command (notmuch_config_t *config, int argc, char *argv[]);
 static int
 notmuch_command (notmuch_config_t *config, int argc, char *argv[]);
 
 static int
 notmuch_command (notmuch_config_t *config, int argc, char *argv[]);
 

+static int
+_help_for (const char *topic);
+
+static bool print_version = false, print_help = false;
+const char *notmuch_requested_db_uuid = NULL;
+
+const notmuch_opt_desc_t notmuch_shared_options [] = {
+    { .opt_bool = &print_version, .name = "version" },
+    { .opt_bool = &print_help, .name = "help" },
+    { .opt_string = &notmuch_requested_db_uuid, .name = "uuid" },
+    { }
+};
+
+/* any subcommand wanting to support these options should call
+ * inherit notmuch_shared_options and call
+ * notmuch_process_shared_options (subcommand_name);
+ */
+void
+notmuch_process_shared_options (const char *subcommand_name) {
+    if (print_version) {
+       printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
+       exit (EXIT_SUCCESS);
+    }
+
+    if (print_help) {
+       int ret = _help_for (subcommand_name);
+       exit (ret);
+    }
+}
+
+/* This is suitable for subcommands that do not actually open the
+ * database.
+ */
+int notmuch_minimal_options (const char *subcommand_name,
+                                 int argc, char **argv)
+{
+    int opt_index;
+
+    notmuch_opt_desc_t options[] = {
+       { .opt_inherit = notmuch_shared_options },
+       { }
+    };
+
+    opt_index = parse_arguments (argc, argv, options, 1);
+
+    if (opt_index < 0)
+       return -1;
+
+    /* We can't use argv here as it is sometimes NULL */
+    notmuch_process_shared_options (subcommand_name);
+    return opt_index;
+}
+
+
+struct _notmuch_client_indexing_cli_choices indexing_cli_choices = { };
+const notmuch_opt_desc_t  notmuch_shared_indexing_options [] = {
+    { .opt_bool = &indexing_cli_choices.try_decrypt,
+      .present = &indexing_cli_choices.try_decrypt_set,
+      .name = "try-decrypt" },
+    { }
+};
+
+
+notmuch_status_t
+notmuch_process_shared_indexing_options (notmuch_database_t *notmuch, g_mime_3_unused(notmuch_config_t *config))
+{
+    if (indexing_cli_choices.opts == NULL)
+       indexing_cli_choices.opts = notmuch_database_get_default_indexopts (notmuch);
+    if (indexing_cli_choices.try_decrypt_set) {
+       notmuch_status_t status;
+       if (indexing_cli_choices.opts == NULL)
+           return NOTMUCH_STATUS_OUT_OF_MEMORY;
+       status = notmuch_indexopts_set_try_decrypt (indexing_cli_choices.opts, indexing_cli_choices.try_decrypt);
+       if (status != NOTMUCH_STATUS_SUCCESS) {
+           fprintf (stderr, "Error: Failed to set try_decrypt to %s. (%s)\n",
+                    indexing_cli_choices.try_decrypt ? "True" : "False", notmuch_status_to_string (status));
+           notmuch_indexopts_destroy (indexing_cli_choices.opts);
+           indexing_cli_choices.opts = NULL;
+           return status;
+       }
+    }
+#if (GMIME_MAJOR_VERSION < 3)
+    if (indexing_cli_choices.opts && notmuch_indexopts_get_try_decrypt (indexing_cli_choices.opts)) {
+       const char* gpg_path = notmuch_config_get_crypto_gpg_path (config);
+       if (gpg_path && strcmp(gpg_path, "gpg"))
+           fprintf (stderr, "Warning: deprecated crypto.gpg_path is set to '%s'\n"
+                    "\tbut ignoring (use $PATH instead)\n", gpg_path);
+    }
+#endif
+    return NOTMUCH_STATUS_SUCCESS;
+}
+
+

 static command_t commands[] = {
 static command_t commands[] = {

-    { NULL, notmuch_command, TRUE,
+    { NULL, notmuch_command, NOTMUCH_CONFIG_OPEN | NOTMUCH_CONFIG_CREATE,

       "Notmuch main command." },
       "Notmuch main command." },

-    { "setup", notmuch_setup_command, TRUE,
-      "Interactively setup notmuch for first use." },
-    { "new", notmuch_new_command, FALSE,
+    { "setup", notmuch_setup_command, NOTMUCH_CONFIG_OPEN | NOTMUCH_CONFIG_CREATE,
+      "Interactively set up notmuch for first use." },
+    { "new", notmuch_new_command, NOTMUCH_CONFIG_OPEN,

       "Find and import new messages to the notmuch database." },
       "Find and import new messages to the notmuch database." },

-    { "insert", notmuch_insert_command, FALSE,
+    { "insert", notmuch_insert_command, NOTMUCH_CONFIG_OPEN,

       "Add a new message into the maildir and notmuch database." },
       "Add a new message into the maildir and notmuch database." },

-    { "search", notmuch_search_command, FALSE,
+    { "search", notmuch_search_command, NOTMUCH_CONFIG_OPEN,

       "Search for messages matching the given search terms." },
       "Search for messages matching the given search terms." },

-    { "show", notmuch_show_command, FALSE,
+    { "address", notmuch_address_command, NOTMUCH_CONFIG_OPEN,
+      "Get addresses from messages matching the given search terms." },
+    { "show", notmuch_show_command, NOTMUCH_CONFIG_OPEN,

       "Show all messages matching the search terms." },
       "Show all messages matching the search terms." },

-    { "count", notmuch_count_command, FALSE,
+    { "count", notmuch_count_command, NOTMUCH_CONFIG_OPEN,

       "Count messages matching the search terms." },
       "Count messages matching the search terms." },

-    { "reply", notmuch_reply_command, FALSE,
+    { "reply", notmuch_reply_command, NOTMUCH_CONFIG_OPEN,

       "Construct a reply template for a set of messages." },
       "Construct a reply template for a set of messages." },

-    { "tag", notmuch_tag_command, FALSE,
+    { "tag", notmuch_tag_command, NOTMUCH_CONFIG_OPEN,

       "Add/remove tags for all messages matching the search terms." },
       "Add/remove tags for all messages matching the search terms." },

-    { "dump", notmuch_dump_command, FALSE,
+    { "dump", notmuch_dump_command, NOTMUCH_CONFIG_OPEN,

       "Create a plain-text dump of the tags for each message." },
       "Create a plain-text dump of the tags for each message." },

-    { "restore", notmuch_restore_command, FALSE,
+    { "restore", notmuch_restore_command, NOTMUCH_CONFIG_OPEN,

       "Restore the tags from the given dump file (see 'dump')." },
       "Restore the tags from the given dump file (see 'dump')." },

-    { "compact", notmuch_compact_command, FALSE,
+    { "compact", notmuch_compact_command, NOTMUCH_CONFIG_OPEN,

       "Compact the notmuch database." },
       "Compact the notmuch database." },

-    { "config", notmuch_config_command, FALSE,
+    { "reindex", notmuch_reindex_command, NOTMUCH_CONFIG_OPEN,
+      "Re-index all messages matching the search terms." },
+    { "config", notmuch_config_command, NOTMUCH_CONFIG_OPEN,

       "Get or set settings in the notmuch configuration file." },
       "Get or set settings in the notmuch configuration file." },

-    { "help", notmuch_help_command, TRUE, /* create but don't save config */
+#if WITH_EMACS
+    { "emacs-mua", NULL, 0,
+      "send mail with notmuch and emacs." },
+#endif
+    { "help", notmuch_help_command, NOTMUCH_CONFIG_CREATE, /* create but don't save config */

       "This message, or more detailed help for the named command." }
 };
 
       "This message, or more detailed help for the named command." }
 };
 


@@ -165,6 +266,22 @@ be supported in the future.\n", notmuch_format_version);
     }
 }
 
     }
 }
 

+void
+notmuch_exit_if_unmatched_db_uuid (notmuch_database_t *notmuch)
+{
+    const char *uuid = NULL;
+
+    if (!notmuch_requested_db_uuid)
+       return;
+    IGNORE_RESULT (notmuch_database_get_revision (notmuch, &uuid));
+
+    if (strcmp (notmuch_requested_db_uuid, uuid) != 0){
+       fprintf (stderr, "Error: requested database revision %s does not match %s\n",
+                notmuch_requested_db_uuid, uuid);
+       exit (1);
+    }
+}
+

 static void
 exec_man (const char *page)
 {
 static void
 exec_man (const char *page)
 {


@@ -175,21 +292,19 @@ exec_man (const char *page)
 }
 
 static int
 }
 
 static int

-notmuch_help_command (notmuch_config_t *config, int argc, char *argv[])
+_help_for (const char *topic_name)

 {
     command_t *command;
     help_topic_t *topic;
     unsigned int i;
 
 {
     command_t *command;
     help_topic_t *topic;
     unsigned int i;
 

-    argc--; argv++; /* Ignore "help" */
-
-    if (argc == 0) {
+    if (!topic_name) {

        printf ("The notmuch mail system.\n\n");
        usage (stdout);
        return EXIT_SUCCESS;
     }
 
        printf ("The notmuch mail system.\n\n");
        usage (stdout);
        return EXIT_SUCCESS;
     }
 

-    if (strcmp (argv[0], "help") == 0) {
+    if (strcmp (topic_name, "help") == 0) {

        printf ("The notmuch help system.\n\n"
                "\tNotmuch uses the man command to display help. In case\n"
                "\tof difficulties check that MANPATH includes the pages\n"
        printf ("The notmuch help system.\n\n"
                "\tNotmuch uses the man command to display help. In case\n"
                "\tof difficulties check that MANPATH includes the pages\n"


@@ -198,26 +313,46 @@ notmuch_help_command (notmuch_config_t *config, int argc, char *argv[])
        return EXIT_SUCCESS;
     }
 
        return EXIT_SUCCESS;
     }
 

-    command = find_command (argv[0]);
+    command = find_command (topic_name);

     if (command) {
     if (command) {

-       char *page = talloc_asprintf (config, "notmuch-%s", command->name);
+       char *page = talloc_asprintf (NULL, "notmuch-%s", command->name);

        exec_man (page);
     }
 
     for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
        topic = &help_topics[i];
        exec_man (page);
     }
 
     for (i = 0; i < ARRAY_SIZE (help_topics); i++) {
        topic = &help_topics[i];

-       if (strcmp (argv[0], topic->name) == 0) {
-           char *page = talloc_asprintf (config, "notmuch-%s", topic->name);
+       if (strcmp (topic_name, topic->name) == 0) {
+           char *page = talloc_asprintf (NULL, "notmuch-%s", topic->name);

            exec_man (page);
        }
     }
 
     fprintf (stderr,
             "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
            exec_man (page);
        }
     }
 
     fprintf (stderr,
             "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",

-            argv[0]);
+            topic_name);

     return EXIT_FAILURE;
 }
 
     return EXIT_FAILURE;
 }
 

+static int
+notmuch_help_command (unused (notmuch_config_t * config), int argc, char *argv[])
+{
+    int opt_index;
+
+    opt_index = notmuch_minimal_options ("help", argc, argv);
+    if (opt_index < 0)
+       return EXIT_FAILURE;
+
+    /* skip at least subcommand argument */
+    argc-= opt_index;
+    argv+= opt_index;
+
+    if (argc == 0) {
+       return _help_for (NULL);
+    }
+
+    return _help_for (argv[0]);
+}
+

 /* Handle the case of "notmuch" being invoked with no command
  * argument. For now we just call notmuch_setup_command, but we plan
  * to be more clever about this in the future.
 /* Handle the case of "notmuch" being invoked with no command
  * argument. For now we just call notmuch_setup_command, but we plan
  * to be more clever about this in the future.


@@ -265,7 +400,7 @@ notmuch_command (notmuch_config_t *config,
            "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
            "from a search. Finally, you may want to explore using a more sophisticated\n"
            "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
            "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
            "from a search. Finally, you may want to explore using a more sophisticated\n"
            "interface to notmuch such as the emacs interface implemented in notmuch.el\n"

-           "or any other interface described at http://notmuchmail.org\n\n"
+           "or any other interface described at https://notmuchmail.org\n\n"

            "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
            "Have fun, and may your inbox never have much mail.\n\n",
            notmuch_config_get_user_name (config),
            "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
            "Have fun, and may your inbox never have much mail.\n\n",
            notmuch_config_get_user_name (config),


@@ -274,6 +409,39 @@ notmuch_command (notmuch_config_t *config,
     return EXIT_SUCCESS;
 }
 
     return EXIT_SUCCESS;
 }
 

+/*
+ * Try to run subcommand in argv[0] as notmuch- prefixed external
+ * command. argv must be NULL terminated (argv passed to main always
+ * is).
+ *
+ * Does not return if the external command is found and
+ * executed. Return true if external command is not found. Return
+ * false on errors.
+ */
+static bool try_external_command(char *argv[])
+{
+    char *old_argv0 = argv[0];
+    bool ret = true;
+
+    argv[0] = talloc_asprintf (NULL, "notmuch-%s", old_argv0);
+
+    /*
+     * This will only return on errors. Not finding an external
+     * command (ENOENT) is not an error from our perspective.
+     */
+    execvp (argv[0], argv);
+    if (errno != ENOENT) {
+       fprintf (stderr, "Error: Running external command '%s' failed: %s\n",
+                argv[0], strerror(errno));
+       ret = false;
+    }
+
+    talloc_free (argv[0]);
+    argv[0] = old_argv0;
+
+    return ret;
+}
+

 int
 main (int argc, char *argv[])
 {
 int
 main (int argc, char *argv[])
 {


@@ -281,17 +449,15 @@ main (int argc, char *argv[])
     char *talloc_report;
     const char *command_name = NULL;
     command_t *command;
     char *talloc_report;
     const char *command_name = NULL;
     command_t *command;

-    char *config_file_name = NULL;
+    const char *config_file_name = NULL;

     notmuch_config_t *config = NULL;
     notmuch_config_t *config = NULL;

-    notmuch_bool_t print_help=FALSE, print_version=FALSE;

     int opt_index;
     int ret;
 
     notmuch_opt_desc_t options[] = {
     int opt_index;
     int ret;
 
     notmuch_opt_desc_t options[] = {

-       { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
-       { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
-       { NOTMUCH_OPT_STRING, &config_file_name, "config", 'c', 0 },
-       { 0, 0, 0, 0, 0 }
+       { .opt_string = &config_file_name, .name = "config" },
+       { .opt_inherit = notmuch_shared_options },
+       { }

     };
 
     talloc_enable_null_tracking ();
     };
 
     talloc_enable_null_tracking ();


@@ -312,29 +478,23 @@ main (int argc, char *argv[])
        goto DONE;
     }
 
        goto DONE;
     }
 

-    if (print_help) {
-       ret = notmuch_help_command (NULL, argc - 1, &argv[1]);
-       goto DONE;
-    }
-
-    if (print_version) {
-       printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
-       ret = EXIT_SUCCESS;
-       goto DONE;
-    }
-

     if (opt_index < argc)
        command_name = argv[opt_index];
 
     if (opt_index < argc)
        command_name = argv[opt_index];
 

+    notmuch_process_shared_options (command_name);
+

     command = find_command (command_name);
     command = find_command (command_name);

-    if (!command) {
-       fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
-                command_name);
+    /* if command->function is NULL, try external command */
+    if (!command || !command->function) {
+       /* This won't return if the external command is found. */
+       if (try_external_command(argv + opt_index))
+           fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
+                    command_name);

        ret = EXIT_FAILURE;
        goto DONE;
     }
 
        ret = EXIT_FAILURE;
        goto DONE;
     }
 

-    config = notmuch_config_open (local, config_file_name, command->create_config);
+    config = notmuch_config_open (local, config_file_name, command->config_mode);

     if (!config) {
        ret = EXIT_FAILURE;
        goto DONE;
     if (!config) {
        ret = EXIT_FAILURE;
        goto DONE;