]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-tag.c
notmuch-tag: tidy formatting
[notmuch] / notmuch-tag.c
index 7d92ec485eabc7233d176bc2b8374a81bde494c5..88d559be77cd6bb12349e2a12238bfb7090b0f38 100644 (file)
@@ -26,24 +26,159 @@ static void
 handle_sigint (unused (int sig))
 {
     static char msg[] = "Stopping...         \n";
-    write(2, msg, sizeof(msg)-1);
+
+    /* This write is "opportunistic", so it's okay to ignore the
+     * result.  It is not required for correctness, and if it does
+     * fail or produce a short write, we want to get out of the signal
+     * handler as quickly as possible, not retry it. */
+    IGNORE_RESULT (write (2, msg, sizeof (msg) - 1));
     interrupted = 1;
 }
 
+static char *
+_escape_tag (char *buf, const char *tag)
+{
+    const char *in = tag;
+    char *out = buf;
+
+    /* Boolean terms surrounded by double quotes can contain any
+     * character.  Double quotes are quoted by doubling them. */
+    *out++ = '"';
+    while (*in) {
+       if (*in == '"')
+           *out++ = '"';
+       *out++ = *in++;
+    }
+    *out++ = '"';
+    *out = 0;
+    return buf;
+}
+
+typedef struct {
+    const char *tag;
+    notmuch_bool_t remove;
+} tag_operation_t;
+
+static char *
+_optimize_tag_query (void *ctx, const char *orig_query_string,
+                    const tag_operation_t *tag_ops)
+{
+    /* This is subtler than it looks.  Xapian ignores the '-' operator
+     * at the beginning both queries and parenthesized groups and,
+     * furthermore, the presence of a '-' operator at the beginning of
+     * a group can inhibit parsing of the previous operator.  Hence,
+     * the user-provided query MUST appear first, but it is safe to
+     * parenthesize and the exclusion part of the query must not use
+     * the '-' operator (though the NOT operator is fine). */
+
+    char *escaped, *query_string;
+    const char *join = "";
+    int i;
+    unsigned int max_tag_len = 0;
+
+    /* Don't optimize if there are no tag changes. */
+    if (tag_ops[0].tag == NULL)
+       return talloc_strdup (ctx, orig_query_string);
+
+    /* Allocate a buffer for escaping tags.  This is large enough to
+     * hold a fully escaped tag with every character doubled plus
+     * enclosing quotes and a NUL. */
+    for (i = 0; tag_ops[i].tag; i++)
+       if (strlen (tag_ops[i].tag) > max_tag_len)
+           max_tag_len = strlen (tag_ops[i].tag);
+    escaped = talloc_array (ctx, char, max_tag_len * 2 + 3);
+    if (! escaped)
+       return NULL;
+
+    /* Build the new query string */
+    if (strcmp (orig_query_string, "*") == 0)
+       query_string = talloc_strdup (ctx, "(");
+    else
+       query_string = talloc_asprintf (ctx, "( %s ) and (", orig_query_string);
+
+    for (i = 0; tag_ops[i].tag && query_string; i++) {
+       query_string = talloc_asprintf_append_buffer (
+           query_string, "%s%stag:%s", join,
+           tag_ops[i].remove ? "" : "not ",
+           _escape_tag (escaped, tag_ops[i].tag));
+       join = " or ";
+    }
+
+    if (query_string)
+       query_string = talloc_strdup_append_buffer (query_string, ")");
+
+    talloc_free (escaped);
+    return query_string;
+}
+
+/* Tag messages matching 'query_string' according to 'tag_ops', which
+ * must be an array of tagging operations terminated with an empty
+ * element. */
+static int
+tag_query (void *ctx, notmuch_database_t *notmuch, const char *query_string,
+          tag_operation_t *tag_ops, notmuch_bool_t synchronize_flags)
+{
+    notmuch_query_t *query;
+    notmuch_messages_t *messages;
+    notmuch_message_t *message;
+    int i;
+
+    /* Optimize the query so it excludes messages that already have
+     * the specified set of tags. */
+    query_string = _optimize_tag_query (ctx, query_string, tag_ops);
+    if (query_string == NULL) {
+       fprintf (stderr, "Out of memory.\n");
+       return 1;
+    }
+
+    query = notmuch_query_create (notmuch, query_string);
+    if (query == NULL) {
+       fprintf (stderr, "Out of memory.\n");
+       return 1;
+    }
+
+    /* tagging is not interested in any special sort order */
+    notmuch_query_set_sort (query, NOTMUCH_SORT_UNSORTED);
+
+    for (messages = notmuch_query_search_messages (query);
+        notmuch_messages_valid (messages) && ! interrupted;
+        notmuch_messages_move_to_next (messages)) {
+       message = notmuch_messages_get (messages);
+
+       notmuch_message_freeze (message);
+
+       for (i = 0; tag_ops[i].tag; i++) {
+           if (tag_ops[i].remove)
+               notmuch_message_remove_tag (message, tag_ops[i].tag);
+           else
+               notmuch_message_add_tag (message, tag_ops[i].tag);
+       }
+
+       notmuch_message_thaw (message);
+
+       if (synchronize_flags)
+           notmuch_message_tags_to_maildir_flags (message);
+
+       notmuch_message_destroy (message);
+    }
+
+    notmuch_query_destroy (query);
+
+    return interrupted;
+}
+
 int
-notmuch_tag_command (void *ctx, unused (int argc), unused (char *argv[]))
+notmuch_tag_command (void *ctx, int argc, char *argv[])
 {
-    int *add_tags, *remove_tags;
-    int add_tags_count = 0;
-    int remove_tags_count = 0;
+    tag_operation_t *tag_ops;
+    int tag_ops_count = 0;
     char *query_string;
     notmuch_config_t *config;
     notmuch_database_t *notmuch;
-    notmuch_query_t *query;
-    notmuch_messages_t *messages;
-    notmuch_message_t *message;
     struct sigaction action;
+    notmuch_bool_t synchronize_flags;
     int i;
+    int ret;
 
     /* Setup our handler for SIGINT */
     memset (&action, 0, sizeof (struct sigaction));
@@ -52,14 +187,12 @@ notmuch_tag_command (void *ctx, unused (int argc), unused (char *argv[]))
     action.sa_flags = SA_RESTART;
     sigaction (SIGINT, &action, NULL);
 
-    add_tags = talloc_size (ctx, argc * sizeof (int));
-    if (add_tags == NULL) {
-       fprintf (stderr, "Out of memory.\n");
-       return 1;
-    }
+    argc--; argv++; /* skip subcommand argument */
 
-    remove_tags = talloc_size (ctx, argc * sizeof (int));
-    if (remove_tags == NULL) {
+    /* Array of tagging operations (add or remove), terminated with an
+     * empty element. */
+    tag_ops = talloc_array (ctx, tag_operation_t, argc + 1);
+    if (tag_ops == NULL) {
        fprintf (stderr, "Out of memory.\n");
        return 1;
     }
@@ -69,22 +202,37 @@ notmuch_tag_command (void *ctx, unused (int argc), unused (char *argv[]))
            i++;
            break;
        }
-       if (argv[i][0] == '+') {
-           add_tags[add_tags_count++] = i;
-       } else if (argv[i][0] == '-') {
-           remove_tags[remove_tags_count++] = i;
+       if (argv[i][0] == '+' || argv[i][0] == '-') {
+           if (argv[i][0] == '+' && argv[i][1] == '\0') {
+               fprintf (stderr, "Error: tag names cannot be empty.\n");
+               return 1;
+           }
+           if (argv[i][0] == '+' && argv[i][1] == '-') {
+               /* This disallows adding the non-removable tag "-" and
+                * enables notmuch tag to take long options in the
+                * future. */
+               fprintf (stderr, "Error: tag names must not start with '-'.\n");
+               return 1;
+           }
+           tag_ops[tag_ops_count].tag = argv[i] + 1;
+           tag_ops[tag_ops_count].remove = (argv[i][0] == '-');
+           tag_ops_count++;
        } else {
            break;
        }
     }
 
-    if (add_tags_count == 0 && remove_tags_count == 0) {
+    tag_ops[tag_ops_count].tag = NULL;
+
+    if (tag_ops_count == 0) {
        fprintf (stderr, "Error: 'notmuch tag' requires at least one tag to add or remove.\n");
        return 1;
     }
 
-    if (i == argc) {
-       fprintf (stderr, "Error: 'notmuch tag' requires at least one search term.\n");
+    query_string = query_string_from_args (ctx, argc - i, &argv[i]);
+
+    if (*query_string == '\0') {
+       fprintf (stderr, "Error: notmuch tag requires at least one search term.\n");
        return 1;
     }
 
@@ -92,40 +240,15 @@ notmuch_tag_command (void *ctx, unused (int argc), unused (char *argv[]))
     if (config == NULL)
        return 1;
 
-    notmuch = notmuch_database_open (notmuch_config_get_database_path (config));
-    if (notmuch == NULL)
+    if (notmuch_database_open (notmuch_config_get_database_path (config),
+                              NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))
        return 1;
 
-    query_string = query_string_from_args (ctx, argc - i, &argv[i]);
+    synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);
 
-    query = notmuch_query_create (notmuch, query_string);
-    if (query == NULL) {
-       fprintf (stderr, "Out of memory.\n");
-       return 1;
-    }
-
-    for (messages = notmuch_query_search_messages (query, 0, -1);
-        notmuch_messages_has_more (messages) && !interrupted;
-        notmuch_messages_advance (messages))
-    {
-       message = notmuch_messages_get (messages);
-
-       notmuch_message_freeze (message);
+    ret = tag_query (ctx, notmuch, query_string, tag_ops, synchronize_flags);
 
-       for (i = 0; i < remove_tags_count; i++)
-           notmuch_message_remove_tag (message,
-                                       argv[remove_tags[i]] + 1);
+    notmuch_database_destroy (notmuch);
 
-       for (i = 0; i < add_tags_count; i++)
-           notmuch_message_add_tag (message, argv[add_tags[i]] + 1);
-
-       notmuch_message_thaw (message);
-
-       notmuch_message_destroy (message);
-    }
-
-    notmuch_query_destroy (query);
-    notmuch_database_close (notmuch);
-
-    return interrupted;
+    return ret;
 }