]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-restore.c
util: Fix two corner-cases in boolean term quoting function
[notmuch] / notmuch-restore.c
index ff1ebab10d758b963a4774f91e89a43c6be3c50f..f23ab983a93da0a84020ee460300f4f631225743 100644 (file)
  * Author: Carl Worth <cworth@cworth.org>
  */
 
-#include <getopt.h>
-
 #include "notmuch-client.h"
+#include "dump-restore-private.h"
+#include "tag-util.h"
+#include "string-util.h"
 
-int
-notmuch_restore_command (unused (void *ctx), int argc, char *argv[])
+static regex_t regex;
+
+/* Non-zero return indicates an error in retrieving the message,
+ * or in applying the tags.  Missing messages are reported, but not
+ * considered errors.
+ */
+static int
+tag_message (unused (void *ctx),
+            notmuch_database_t *notmuch,
+            const char *message_id,
+            tag_op_list_t *tag_ops,
+            tag_op_flag_t flags)
 {
-    notmuch_config_t *config;
-    notmuch_database_t *notmuch;
-    notmuch_bool_t synchronize_flags;
-    notmuch_bool_t accumulate = FALSE;
-    FILE *input = stdin;
-    char *line = NULL;
-    size_t line_size;
-    ssize_t line_len;
-    regex_t regex;
+    notmuch_status_t status;
+    notmuch_message_t *message = NULL;
+    int ret = 0;
+
+    status = notmuch_database_find_message (notmuch, message_id, &message);
+    if (status) {
+       fprintf (stderr, "Error applying tags to message %s: %s\n",
+                message_id, notmuch_status_to_string (status));
+       return 1;
+    }
+    if (message == NULL) {
+       fprintf (stderr, "Warning: cannot apply tags to missing message: %s\n",
+                message_id);
+       /* We consider this a non-fatal error. */
+       return 0;
+    }
+
+    /* In order to detect missing messages, this check/optimization is
+     * intentionally done *after* first finding the message. */
+    if ((flags & TAG_FLAG_REMOVE_ALL) || tag_op_list_size (tag_ops))
+       ret = tag_op_list_apply (message, tag_ops, flags);
+
+    notmuch_message_destroy (message);
+
+    return ret;
+}
+
+/* Sup dump output is one line per message. We match a sequence of
+ * non-space characters for the message-id, then one or more
+ * spaces, then a list of space-separated tags as a sequence of
+ * characters within literal '(' and ')'. */
+
+static int
+parse_sup_line (void *ctx, char *line,
+               char **query_str, tag_op_list_t *tag_ops)
+{
+
+    regmatch_t match[3];
+    char *file_tags;
     int rerr;
 
-    config = notmuch_config_open (ctx, NULL, NULL);
-    if (config == NULL)
+    tag_op_list_reset (tag_ops);
+
+    chomp_newline (line);
+
+    /* Silently ignore blank lines */
+    if (line[0] == '\0') {
        return 1;
+    }
 
-    notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
-                                    NOTMUCH_DATABASE_MODE_READ_WRITE);
-    if (notmuch == NULL)
+    rerr = xregexec (&regex, line, 3, match, 0);
+    if (rerr == REG_NOMATCH) {
+       fprintf (stderr, "Warning: Ignoring invalid sup format line: %s\n",
+                line);
        return 1;
+    }
 
-    synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);
+    *query_str = talloc_strndup_debug (ctx, line + match[1].rm_so,
+                                      match[1].rm_eo - match[1].rm_so);
 
-    struct option options[] = {
-       { "accumulate",   no_argument,       0, 'a' },
-       { 0, 0, 0, 0}
-    };
+    file_tags = talloc_strndup_debug (ctx, line + match[2].rm_so,
+                                     match[2].rm_eo - match[2].rm_so);
 
-    int opt;
-    do {
-       opt = getopt_long (argc, argv, "", options, NULL);
+    char *tok = file_tags;
+    size_t tok_len = 0;
 
-       switch (opt) {
-       case 'a':
-           accumulate = 1;
-           break;
-       case '?':
-           return 1;
-           break;
+    tag_op_list_reset (tag_ops);
+
+    while ((tok = strtok_len (tok + tok_len, " ", &tok_len)) != NULL) {
+
+       if (*(tok + tok_len) != '\0') {
+           *(tok + tok_len) = '\0';
+           tok_len++;
        }
 
-    } while (opt != -1);
+       if (tag_op_list_append (tag_ops, tok, FALSE))
+           return -1;
+    }
+
+    return 0;
+
+}
 
-    if (optind < argc) {
-       input = fopen (argv[optind], "r");
+int
+notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[])
+{
+    notmuch_database_t *notmuch;
+    notmuch_bool_t accumulate = FALSE;
+    tag_op_flag_t flags = 0;
+    tag_op_list_t *tag_ops;
+
+    char *input_file_name = NULL;
+    FILE *input = stdin;
+    char *line = NULL;
+    void *line_ctx = NULL;
+    size_t line_size;
+    ssize_t line_len;
+
+    int ret = 0;
+    int opt_index;
+    int input_format = DUMP_FORMAT_AUTO;
+
+    if (notmuch_database_open (notmuch_config_get_database_path (config),
+                              NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))
+       return EXIT_FAILURE;
+
+    if (notmuch_config_get_maildir_synchronize_flags (config))
+       flags |= TAG_FLAG_MAILDIR_SYNC;
+
+    notmuch_opt_desc_t options[] = {
+       { NOTMUCH_OPT_KEYWORD, &input_format, "format", 'f',
+         (notmuch_keyword_t []){ { "auto", DUMP_FORMAT_AUTO },
+                                 { "batch-tag", DUMP_FORMAT_BATCH_TAG },
+                                 { "sup", DUMP_FORMAT_SUP },
+                                 { 0, 0 } } },
+       { NOTMUCH_OPT_STRING, &input_file_name, "input", 'i', 0 },
+       { NOTMUCH_OPT_BOOLEAN,  &accumulate, "accumulate", 'a', 0 },
+       { 0, 0, 0, 0, 0 }
+    };
+
+    opt_index = parse_arguments (argc, argv, options, 1);
+    if (opt_index < 0)
+       return EXIT_FAILURE;
+
+    if (! accumulate)
+       flags |= TAG_FLAG_REMOVE_ALL;
+
+    if (input_file_name) {
+       input = fopen (input_file_name, "r");
        if (input == NULL) {
            fprintf (stderr, "Error opening %s for reading: %s\n",
-                    argv[optind], strerror (errno));
-           return 1;
+                    input_file_name, strerror (errno));
+           return EXIT_FAILURE;
        }
-       optind++;
     }
 
-    if (optind < argc) {
-       fprintf (stderr,
-        "Cannot read dump from more than one file: %s\n",
-                argv[optind]);
-       return 1;
+    if (opt_index < argc) {
+       fprintf (stderr, "Unused positional parameter: %s\n", argv[opt_index]);
+       return EXIT_FAILURE;
     }
 
-    /* Dump output is one line per message. We match a sequence of
-     * non-space characters for the message-id, then one or more
-     * spaces, then a list of space-separated tags as a sequence of
-     * characters within literal '(' and ')'. */
-    xregcomp (&regex,
-             "^([^ ]+) \\(([^)]*)\\)$",
-             REG_EXTENDED);
-
-    while ((line_len = getline (&line, &line_size, input)) != -1) {
-       regmatch_t match[3];
-       char *message_id, *file_tags, *tag, *next;
-       notmuch_message_t *message = NULL;
-       notmuch_status_t status;
-       notmuch_tags_t *db_tags;
-       char *db_tags_str;
-
-       chomp_newline (line);
-
-       rerr = xregexec (&regex, line, 3, match, 0);
-       if (rerr == REG_NOMATCH)
-       {
-           fprintf (stderr, "Warning: Ignoring invalid input line: %s\n",
-                    line);
-           continue;
-       }
+    tag_ops = tag_op_list_create (config);
+    if (tag_ops == NULL) {
+       fprintf (stderr, "Out of memory.\n");
+       return EXIT_FAILURE;
+    }
 
-       message_id = xstrndup (line + match[1].rm_so,
-                              match[1].rm_eo - match[1].rm_so);
-       file_tags = xstrndup (line + match[2].rm_so,
-                             match[2].rm_eo - match[2].rm_so);
-
-       status = notmuch_database_find_message (notmuch, message_id, &message);
-       if (status || message == NULL) {
-           fprintf (stderr, "Warning: Cannot apply tags to %smessage: %s\n",
-                    message ? "" : "missing ", message_id);
-           if (status)
-               fprintf (stderr, "%s\n",
-                        notmuch_status_to_string(status));
-           goto NEXT_LINE;
-       }
+    do {
+       line_len = getline (&line, &line_size, input);
 
-       /* In order to detect missing messages, this check/optimization is
-        * intentionally done *after* first finding the message.  */
-       if (accumulate && (file_tags == NULL || *file_tags == '\0'))
-       {
-           goto NEXT_LINE;
-       }
+       /* empty input file not considered an error */
+       if (line_len < 0)
+           return EXIT_SUCCESS;
 
-       db_tags_str = NULL;
-       for (db_tags = notmuch_message_get_tags (message);
-            notmuch_tags_valid (db_tags);
-            notmuch_tags_move_to_next (db_tags))
-       {
-           const char *tag = notmuch_tags_get (db_tags);
-
-           if (db_tags_str)
-               db_tags_str = talloc_asprintf_append (db_tags_str, " %s", tag);
-           else
-               db_tags_str = talloc_strdup (message, tag);
-       }
+    } while ((line_len == 0) ||
+            (line[0] == '#') ||
+            /* the cast is safe because we checked about for line_len < 0 */
+            (strspn (line, " \t\n") == (unsigned)line_len));
 
-       if (((file_tags == NULL || *file_tags == '\0') &&
-            (db_tags_str == NULL || *db_tags_str == '\0')) ||
-           (file_tags && db_tags_str && strcmp (file_tags, db_tags_str) == 0))
-       {
-           goto NEXT_LINE;
-       }
+    char *p;
+    for (p = line; (input_format == DUMP_FORMAT_AUTO) && *p; p++) {
+       if (*p == '(')
+           input_format = DUMP_FORMAT_SUP;
+    }
+
+    if (input_format == DUMP_FORMAT_AUTO)
+       input_format = DUMP_FORMAT_BATCH_TAG;
 
-       notmuch_message_freeze (message);
-
-       if (!accumulate)
-           notmuch_message_remove_all_tags (message);
-
-       next = file_tags;
-       while (next) {
-           tag = strsep (&next, " ");
-           if (*tag == '\0')
-               continue;
-           status = notmuch_message_add_tag (message, tag);
-           if (status) {
-               fprintf (stderr,
-                        "Error applying tag %s to message %s:\n",
-                        tag, message_id);
-               fprintf (stderr, "%s\n",
-                        notmuch_status_to_string (status));
+    if (input_format == DUMP_FORMAT_SUP)
+       if ( xregcomp (&regex,
+                      "^([^ ]+) \\(([^)]*)\\)$",
+                      REG_EXTENDED) )
+           INTERNAL_ERROR ("compile time constant regex failed.");
+
+    do {
+       char *query_string, *prefix, *term;
+
+       if (line_ctx != NULL)
+           talloc_free (line_ctx);
+
+       line_ctx = talloc_new (config);
+       if (input_format == DUMP_FORMAT_SUP) {
+           ret = parse_sup_line (line_ctx, line, &query_string, tag_ops);
+       } else {
+           ret = parse_tag_line (line_ctx, line, TAG_FLAG_BE_GENEROUS,
+                                 &query_string, tag_ops);
+
+           if (ret == 0) {
+               ret = parse_boolean_term (line_ctx, query_string,
+                                         &prefix, &term);
+               if (ret && errno == EINVAL) {
+                   fprintf (stderr, "Warning: cannot parse query: %s (skipping)\n", query_string);
+                   continue;
+               } else if (ret) {
+                   /* This is more fatal (e.g., out of memory) */
+                   fprintf (stderr, "Error parsing query: %s\n",
+                            strerror (errno));
+                   ret = 1;
+                   break;
+               } else if (strcmp ("id", prefix) != 0) {
+                   fprintf (stderr, "Warning: not an id query: %s (skipping)\n", query_string);
+                   continue;
+               }
+               query_string = term;
            }
        }
 
-       notmuch_message_thaw (message);
+       if (ret > 0)
+           continue;
 
-       if (synchronize_flags)
-           notmuch_message_tags_to_maildir_flags (message);
+       if (ret < 0)
+           break;
 
-      NEXT_LINE:
-       if (message)
-           notmuch_message_destroy (message);
-       message = NULL;
-       free (message_id);
-       free (file_tags);
-    }
+       ret = tag_message (line_ctx, notmuch, query_string,
+                          tag_ops, flags);
+       if (ret)
+           break;
 
-    regfree (&regex);
+    }  while ((line_len = getline (&line, &line_size, input)) != -1);
+
+    if (line_ctx != NULL)
+       talloc_free (line_ctx);
+
+    if (input_format == DUMP_FORMAT_SUP)
+       regfree (&regex);
 
     if (line)
        free (line);
 
-    notmuch_database_close (notmuch);
+    notmuch_database_destroy (notmuch);
+
     if (input != stdin)
        fclose (input);
 
-    return 0;
+    return ret ? EXIT_FAILURE : EXIT_SUCCESS;
 }