]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch.c
cli: clean up exit status code returned by the cli commands
[notmuch] / notmuch.c
index 15e90c8155ab2d34e331459ae83e725d39aa2b75..2d7f33d3d8d69c0c9418f57c428bd78c0b7f27ec 100644 (file)
--- a/notmuch.c
+++ b/notmuch.c
 
 #include "notmuch-client.h"
 
+/*
+ * Notmuch subcommand hook.
+ *
+ * The return value will be used as notmuch exit status code,
+ * preferrably EXIT_SUCCESS or EXIT_FAILURE.
+ */
 typedef int (*command_function_t) (notmuch_config_t *config, int argc, char *argv[]);
 
 typedef struct command {
     const char *name;
     command_function_t function;
     notmuch_bool_t create_config;
-    const char *arguments;
     const char *summary;
 } command_t;
 
@@ -40,40 +45,32 @@ notmuch_command (notmuch_config_t *config, int argc, char *argv[]);
 
 static command_t commands[] = {
     { NULL, notmuch_command, TRUE,
-      NULL,
       "Notmuch main command." },
     { "setup", notmuch_setup_command, TRUE,
-      NULL,
       "Interactively setup notmuch for first use." },
     { "new", notmuch_new_command, FALSE,
-      "[options...]",
       "Find and import new messages to the notmuch database." },
+    { "insert", notmuch_insert_command, FALSE,
+      "Add a new message into the maildir and notmuch database." },
     { "search", notmuch_search_command, FALSE,
-      "[options...] <search-terms> [...]",
       "Search for messages matching the given search terms." },
     { "show", notmuch_show_command, FALSE,
-      "<search-terms> [...]",
       "Show all messages matching the search terms." },
     { "count", notmuch_count_command, FALSE,
-      "[options...] <search-terms> [...]",
       "Count messages matching the search terms." },
     { "reply", notmuch_reply_command, FALSE,
-      "[options...] <search-terms> [...]",
       "Construct a reply template for a set of messages." },
     { "tag", notmuch_tag_command, FALSE,
-      "+<tag>|-<tag> [...] [--] <search-terms> [...]" ,
       "Add/remove tags for all messages matching the search terms." },
     { "dump", notmuch_dump_command, FALSE,
-      "[<filename>] [--] [<search-terms>]",
       "Create a plain-text dump of the tags for each message." },
     { "restore", notmuch_restore_command, FALSE,
-      "[--accumulate] [<filename>]",
       "Restore the tags from the given dump file (see 'dump')." },
+    { "compact", notmuch_compact_command, FALSE,
+      "Compact the notmuch database." },
     { "config", notmuch_config_command, FALSE,
-      "[get|set] <section>.<item> [value ...]",
       "Get or set settings in the notmuch configuration file." },
     { "help", notmuch_help_command, TRUE, /* create but don't save config */
-      "[<command>]",
       "This message, or more detailed help for the named command." }
 };
 
@@ -136,7 +133,7 @@ by the notmuch CLI (it requires at least version %d).  You may need to\n\
 upgrade your notmuch front-end.\n",
                 notmuch_format_version, NOTMUCH_FORMAT_MIN);
        exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
-    } else if (notmuch_format_version != NOTMUCH_FORMAT_CUR) {
+    } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN_ACTIVE) {
        /* Warn about old version requests so compatibility issues are
         * less likely when we drop support for a deprecated format
         * versions. */
@@ -165,7 +162,7 @@ notmuch_help_command (notmuch_config_t *config, int argc, char *argv[])
     if (argc == 0) {
        printf ("The notmuch mail system.\n\n");
        usage (stdout);
-       return 0;
+       return EXIT_SUCCESS;
     }
 
     if (strcmp (argv[0], "help") == 0) {
@@ -174,7 +171,7 @@ notmuch_help_command (notmuch_config_t *config, int argc, char *argv[])
                "\tof difficulties check that MANPATH includes the pages\n"
                "\tinstalled by notmuch.\n\n"
                "\tTry \"notmuch help\" for a list of topics.\n");
-       return 0;
+       return EXIT_SUCCESS;
     }
 
     command = find_command (argv[0]);
@@ -192,7 +189,7 @@ notmuch_help_command (notmuch_config_t *config, int argc, char *argv[])
     fprintf (stderr,
             "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
             argv[0]);
-    return 1;
+    return EXIT_FAILURE;
 }
 
 /* Handle the case of "notmuch" being invoked with no command
@@ -220,7 +217,7 @@ notmuch_command (notmuch_config_t *config,
        if (errno != ENOENT) {
            fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
                     db_path, strerror (errno));
-           return 1;
+           return EXIT_FAILURE;
        }
        printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
                db_path);
@@ -228,7 +225,7 @@ notmuch_command (notmuch_config_t *config,
                "Note that the first run of \"notmuch new\" can take a very long time\n"
                "and that the resulting database will use roughly the same amount of\n"
                "storage space as the email being indexed.\n\n");
-       return 0;
+       return EXIT_SUCCESS;
     }
 
     printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
@@ -248,33 +245,7 @@ notmuch_command (notmuch_config_t *config,
            notmuch_config_get_user_name (config),
            notmuch_config_get_user_primary_email (config));
 
-    return 0;
-}
-
-static int
-redirect_stderr (const char * stderr_file)
-{
-    if (strcmp (stderr_file, "-") == 0) {
-       if (dup2 (STDOUT_FILENO, STDERR_FILENO) < 0) {
-           perror ("dup2");
-           return 1;
-       }
-    } else {
-       int fd = open (stderr_file, O_WRONLY|O_CREAT|O_TRUNC, 0666);
-       if (fd < 0) {
-           fprintf (stderr, "Error: Cannot redirect stderr to '%s': %s\n",
-                    stderr_file, strerror (errno));
-           return 1;
-       }
-       if (fd != STDERR_FILENO) {
-           if (dup2 (fd, STDERR_FILENO) < 0) {
-               perror ("dup2");
-               return 1;
-           }
-           close (fd);
-       }
-    }
-    return 0;
+    return EXIT_SUCCESS;
 }
 
 int
@@ -285,17 +256,15 @@ main (int argc, char *argv[])
     const char *command_name = NULL;
     command_t *command;
     char *config_file_name = NULL;
-    char *stderr_file = NULL;
     notmuch_config_t *config;
     notmuch_bool_t print_help=FALSE, print_version=FALSE;
     int opt_index;
-    int ret = 0;
+    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 },
-       { NOTMUCH_OPT_STRING, &stderr_file, "stderr", '\0', 0 },
        { 0, 0, 0, 0, 0 }
     };
 
@@ -303,28 +272,29 @@ main (int argc, char *argv[])
 
     local = talloc_new (NULL);
 
-    g_mime_init (0);
+    g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
+#if !GLIB_CHECK_VERSION(2, 35, 1)
     g_type_init ();
+#endif
 
     /* Globally default to the current output format version. */
     notmuch_format_version = NOTMUCH_FORMAT_CUR;
 
     opt_index = parse_arguments (argc, argv, options, 1);
     if (opt_index < 0) {
-       /* diagnostics already printed */
-       return 1;
+       ret = EXIT_FAILURE;
+       goto DONE;
     }
 
-    if (stderr_file && redirect_stderr (stderr_file) != 0) {
-       /* error already printed */
-       return 1;
+    if (print_help) {
+       ret = notmuch_help_command (NULL, argc - 1, &argv[1]);
+       goto DONE;
     }
-    if (print_help)
-       return notmuch_help_command (NULL, argc - 1, &argv[1]);
 
     if (print_version) {
        printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
-       return 0;
+       ret = EXIT_SUCCESS;
+       goto DONE;
     }
 
     if (opt_index < argc)
@@ -334,12 +304,15 @@ main (int argc, char *argv[])
     if (!command) {
        fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
                 command_name);
-       return 1;
+       ret = EXIT_FAILURE;
+       goto DONE;
     }
 
     config = notmuch_config_open (local, config_file_name, command->create_config);
-    if (!config)
-       return 1;
+    if (!config) {
+       ret = EXIT_FAILURE;
+       goto DONE;
+    }
 
     ret = (command->function)(config, argc - opt_index, argv + opt_index);
 
@@ -361,6 +334,7 @@ main (int argc, char *argv[])
        }
     }
 
+  DONE:
     talloc_free (local);
 
     return ret;