]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch.c
cli: plug main notmuch command into subcommand machinery
[notmuch] / notmuch.c
index 477a09cf05dd1bd803e8d68bfadf0e3c82660a65..ec2f20fa45713fd92c5564fa869a10f3e6b7c40f 100644 (file)
--- a/notmuch.c
+++ b/notmuch.c
@@ -31,22 +31,16 @@ typedef struct command {
     const char *summary;
 } command_t;
 
-#define MAX_ALIAS_SUBSTITUTIONS 3
-
-typedef struct alias {
-    const char *name;
-    const char *substitutions[MAX_ALIAS_SUBSTITUTIONS];
-} alias_t;
-
-alias_t aliases[] = {
-    { "part", { "show", "--format=raw"}},
-    { "search-tags", {"search", "--output=tags", "*"}}
-};
-
 static int
 notmuch_help_command (void *ctx, int argc, char *argv[]);
 
+static int
+notmuch_command (void *ctx, int argc, char *argv[]);
+
 static command_t commands[] = {
+    { NULL, notmuch_command,
+      NULL,
+      "Notmuch main command." },
     { "setup", notmuch_setup_command,
       NULL,
       "Interactively setup notmuch for first use." },
@@ -82,6 +76,21 @@ static command_t commands[] = {
       "This message, or more detailed help for the named command." }
 };
 
+static command_t *
+find_command (const char *name)
+{
+    size_t i;
+
+    for (i = 0; i < ARRAY_SIZE (commands); i++)
+       if ((!name && !commands[i].name) ||
+           (name && commands[i].name && strcmp (name, commands[i].name) == 0))
+           return &commands[i];
+
+    return NULL;
+}
+
+int notmuch_format_version;
+
 static void
 usage (FILE *out)
 {
@@ -99,8 +108,8 @@ usage (FILE *out)
     for (i = 0; i < ARRAY_SIZE (commands); i++) {
        command = &commands[i];
 
-       fprintf (out, "  %-11s  %s\n",
-                command->name, command->summary);
+       if (command->name)
+           fprintf (out, "  %-11s  %s\n", command->name, command->summary);
     }
 
     fprintf (out, "\n");
@@ -109,6 +118,33 @@ usage (FILE *out)
     "and \"notmuch help search-terms\" for the common search-terms syntax.\n\n");
 }
 
+void
+notmuch_exit_if_unsupported_format (void)
+{
+    if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
+       fprintf (stderr, "\
+A caller requested output format version %d, but the installed notmuch\n\
+CLI only supports up to format version %d.  You may need to upgrade your\n\
+notmuch CLI.\n",
+                notmuch_format_version, NOTMUCH_FORMAT_CUR);
+       exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
+    } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
+       fprintf (stderr, "\
+A caller requested output format version %d, which is no longer supported\n\
+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) {
+       /* Warn about old version requests so compatibility issues are
+        * less likely when we drop support for a deprecated format
+        * versions. */
+       fprintf (stderr, "\
+A caller requested deprecated output format version %d, which may not\n\
+be supported in the future.\n", notmuch_format_version);
+    }
+}
+
 static void
 exec_man (const char *page)
 {
@@ -122,7 +158,6 @@ static int
 notmuch_help_command (void *ctx, int argc, char *argv[])
 {
     command_t *command;
-    unsigned int i;
 
     argc--; argv++; /* Ignore "help" */
 
@@ -141,13 +176,10 @@ notmuch_help_command (void *ctx, int argc, char *argv[])
        return 0;
     }
 
-    for (i = 0; i < ARRAY_SIZE (commands); i++) {
-       command = &commands[i];
-
-       if (strcmp (argv[0], command->name) == 0) {
-           char *page = talloc_asprintf (ctx, "notmuch-%s", command->name);
-           exec_man (page);
-       }
+    command = find_command (argv[0]);
+    if (command) {
+       char *page = talloc_asprintf (ctx, "notmuch-%s", command->name);
+       exec_man (page);
     }
 
     if (strcmp (argv[0], "search-terms") == 0) {
@@ -167,7 +199,7 @@ notmuch_help_command (void *ctx, int argc, char *argv[])
  * to be more clever about this in the future.
  */
 static int
-notmuch (void *ctx)
+notmuch_command (void *ctx, unused(int argc), unused(char *argv[]))
 {
     notmuch_config_t *config;
     notmuch_bool_t is_new;
@@ -230,10 +262,18 @@ int
 main (int argc, char *argv[])
 {
     void *local;
+    char *talloc_report;
+    const char *command_name = NULL;
     command_t *command;
-    alias_t *alias;
-    unsigned int i, j;
-    const char **argv_local;
+    notmuch_bool_t print_help=FALSE, print_version=FALSE;
+    int opt_index;
+    int ret = 0;
+
+    notmuch_opt_desc_t options[] = {
+       { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
+       { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
+       { 0, 0, 0, 0, 0 }
+    };
 
     talloc_enable_null_tracking ();
 
@@ -242,62 +282,52 @@ main (int argc, char *argv[])
     g_mime_init (0);
     g_type_init ();
 
-    if (argc == 1)
-       return notmuch (local);
+    /* 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;
+    }
 
-    if (STRNCMP_LITERAL (argv[1], "--help") == 0)
+    if (print_help)
        return notmuch_help_command (NULL, argc - 1, &argv[1]);
 
-    if (STRNCMP_LITERAL (argv[1], "--version") == 0) {
+    if (print_version) {
        printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
        return 0;
     }
 
-    for (i = 0; i < ARRAY_SIZE (aliases); i++) {
-       alias = &aliases[i];
-
-       if (strcmp (argv[1], alias->name) == 0)
-       {
-           int substitutions;
-
-           argv_local = talloc_size (local, sizeof (char *) *
-                                     (argc + MAX_ALIAS_SUBSTITUTIONS - 1));
-           if (argv_local == NULL) {
-               fprintf (stderr, "Out of memory.\n");
-               return 1;
-           }
-
-           /* Copy all substution arguments from the alias. */
-           argv_local[0] = argv[0];
-           for (j = 0; j < MAX_ALIAS_SUBSTITUTIONS; j++) {
-               if (alias->substitutions[j] == NULL)
-                   break;
-               argv_local[j+1] = alias->substitutions[j];
-           }
-           substitutions = j;
-
-           /* And copy all original arguments (skipping the argument
-            * that matched the alias of course. */
-           for (j = 2; j < (unsigned) argc; j++) {
-               argv_local[substitutions+j-1] = argv[j];
-           }
-
-           argc += substitutions - 1;
-           argv = (char **) argv_local;
-       }
-    }
-
-    for (i = 0; i < ARRAY_SIZE (commands); i++) {
-       command = &commands[i];
+    if (opt_index < argc)
+       command_name = argv[opt_index];
 
-       if (strcmp (argv[1], command->name) == 0)
-           return (command->function) (local, argc - 1, &argv[1]);
+    command = find_command (command_name);
+    if (!command) {
+       fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
+                command_name);
+       return 1;
     }
 
-    fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
-            argv[1]);
+    ret = (command->function)(local, argc - opt_index, argv + opt_index);
+
+    talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
+    if (talloc_report && strcmp (talloc_report, "") != 0) {
+       /* this relies on the previous call to
+        * talloc_enable_null_tracking
+        */
+
+       FILE *report = fopen (talloc_report, "w");
+       if (report) {
+           talloc_report_full (NULL, report);
+       } else {
+           ret = 1;
+           fprintf (stderr, "ERROR: unable to write talloc log. ");
+           perror (talloc_report);
+       }
+    }
 
     talloc_free (local);
 
-    return 1;
+    return ret;
 }