]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-tag.c
cli: add support for batch tagging operations to "notmuch tag"
[notmuch] / notmuch-tag.c
index 0a6b140c25a66d4a4e1e898695ffb399ce03c11b..4272426638a9132c72959b5770b348e2ea336b8d 100644 (file)
@@ -19,6 +19,8 @@
  */
 
 #include "notmuch-client.h"
+#include "tag-util.h"
+#include "string-util.h"
 
 static volatile sig_atomic_t interrupted;
 
@@ -31,36 +33,14 @@ handle_sigint (unused (int sig))
      * 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));
+    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)
+                    const tag_op_list_t *list)
 {
     /* This is subtler than it looks.  Xapian ignores the '-' operator
      * at the beginning both queries and parenthesized groups and,
@@ -70,36 +50,34 @@ _optimize_tag_query (void *ctx, const char *orig_query_string,
      * parenthesize and the exclusion part of the query must not use
      * the '-' operator (though the NOT operator is fine). */
 
-    char *escaped, *query_string;
+    char *escaped = NULL;
+    size_t escaped_len = 0;
+    char *query_string;
     const char *join = "";
-    int i;
-    unsigned int max_tag_len = 0;
+    size_t i;
 
     /* Don't optimize if there are no tag changes. */
-    if (tag_ops[0].tag == NULL)
+    if (tag_op_list_size (list) == 0)
        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++) {
+    for (i = 0; i < tag_op_list_size (list) && query_string; i++) {
+       /* XXX in case of OOM, query_string will be deallocated when
+        * ctx is, which might be at shutdown */
+       if (make_boolean_term (ctx,
+                              "tag", tag_op_list_tag (list, i),
+                              &escaped, &escaped_len))
+           return NULL;
+
        query_string = talloc_asprintf_append_buffer (
-           query_string, "%s%stag:%s", join,
-           tag_ops[i].remove ? "" : "not ",
-           _escape_tag (escaped, tag_ops[i].tag));
+           query_string, "%s%s%s", join,
+           tag_op_list_isremove (list, i) ? "" : "not ",
+           escaped);
        join = " or ";
     }
 
@@ -110,119 +88,165 @@ _optimize_tag_query (void *ctx, const char *orig_query_string,
     return query_string;
 }
 
-int
-notmuch_tag_command (void *ctx, int argc, char *argv[])
+/* Tag messages matching 'query_string' according to 'tag_ops'
+ */
+static int
+tag_query (void *ctx, notmuch_database_t *notmuch, const char *query_string,
+          tag_op_list_t *tag_ops, tag_op_flag_t flags)
 {
-    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;
 
-    /* Setup our handler for SIGINT */
-    memset (&action, 0, sizeof (struct sigaction));
-    action.sa_handler = handle_sigint;
-    sigemptyset (&action.sa_mask);
-    action.sa_flags = SA_RESTART;
-    sigaction (SIGINT, &action, NULL);
-
-    argc--; argv++; /* skip subcommand argument */
-
-    /* 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) {
+    /* 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;
     }
 
-    for (i = 0; i < argc; i++) {
-       if (strcmp (argv[i], "--") == 0) {
-           i++;
-           break;
-       }
-       if (argv[i][0] == '+' || argv[i][0] == '-') {
-           tag_ops[tag_ops_count].tag = argv[i] + 1;
-           tag_ops[tag_ops_count].remove = (argv[i][0] == '-');
-           tag_ops_count++;
-       } else {
-           break;
-       }
+    query = notmuch_query_create (notmuch, query_string);
+    if (query == NULL) {
+       fprintf (stderr, "Out of memory.\n");
+       return 1;
     }
 
-    tag_ops[tag_ops_count].tag = NULL;
+    /* tagging is not interested in any special sort order */
+    notmuch_query_set_sort (query, NOTMUCH_SORT_UNSORTED);
 
-    if (tag_ops_count == 0) {
-       fprintf (stderr, "Error: 'notmuch tag' requires at least one tag to add or remove.\n");
-       return 1;
+    for (messages = notmuch_query_search_messages (query);
+        notmuch_messages_valid (messages) && ! interrupted;
+        notmuch_messages_move_to_next (messages)) {
+       message = notmuch_messages_get (messages);
+       tag_op_list_apply (message, tag_ops, flags | TAG_FLAG_PRE_OPTIMIZED);
+       notmuch_message_destroy (message);
     }
 
-    query_string = query_string_from_args (ctx, argc - i, &argv[i]);
+    notmuch_query_destroy (query);
 
-    if (*query_string == '\0') {
-       fprintf (stderr, "Error: notmuch tag requires at least one search term.\n");
-       return 1;
-    }
+    return interrupted;
+}
 
-    /* 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) {
+static int
+tag_file (void *ctx, notmuch_database_t *notmuch, tag_op_flag_t flags,
+         FILE *input)
+{
+    char *line = NULL;
+    char *query_string = NULL;
+    size_t line_size = 0;
+    ssize_t line_len;
+    int ret = 0;
+    tag_op_list_t *tag_ops;
+
+    tag_ops = tag_op_list_create (ctx);
+    if (tag_ops == NULL) {
        fprintf (stderr, "Out of memory.\n");
        return 1;
     }
 
-    config = notmuch_config_open (ctx, NULL, NULL);
-    if (config == NULL)
-       return 1;
+    while ((line_len = getline (&line, &line_size, input)) != -1 &&
+          ! interrupted) {
 
-    notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
-                                    NOTMUCH_DATABASE_MODE_READ_WRITE);
-    if (notmuch == NULL)
-       return 1;
+       ret = parse_tag_line (ctx, line, TAG_FLAG_NONE,
+                             &query_string, tag_ops);
 
-    synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);
+       if (ret > 0)
+           continue;
 
-    query = notmuch_query_create (notmuch, query_string);
-    if (query == NULL) {
-       fprintf (stderr, "Out of memory.\n");
-       return 1;
+       if (ret < 0)
+           break;
+
+       ret = tag_query (ctx, notmuch, query_string, tag_ops, flags);
+       if (ret)
+           break;
     }
 
-    /* tagging is not interested in any special sort order */
-    notmuch_query_set_sort (query, NOTMUCH_SORT_UNSORTED);
+    if (line)
+       free (line);
 
-    for (messages = notmuch_query_search_messages (query);
-        notmuch_messages_valid (messages) && !interrupted;
-        notmuch_messages_move_to_next (messages))
-    {
-       message = notmuch_messages_get (messages);
+    return ret;
+}
 
-       notmuch_message_freeze (message);
+int
+notmuch_tag_command (void *ctx, int argc, char *argv[])
+{
+    tag_op_list_t *tag_ops = NULL;
+    char *query_string = NULL;
+    notmuch_config_t *config;
+    notmuch_database_t *notmuch;
+    struct sigaction action;
+    tag_op_flag_t tag_flags = TAG_FLAG_NONE;
+    notmuch_bool_t batch = FALSE;
+    FILE *input = stdin;
+    char *input_file_name = NULL;
+    int opt_index;
+    int ret = 0;
 
-       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);
-       }
+    /* Setup our handler for SIGINT */
+    memset (&action, 0, sizeof (struct sigaction));
+    action.sa_handler = handle_sigint;
+    sigemptyset (&action.sa_mask);
+    action.sa_flags = SA_RESTART;
+    sigaction (SIGINT, &action, NULL);
 
-       notmuch_message_thaw (message);
+    notmuch_opt_desc_t options[] = {
+       { NOTMUCH_OPT_BOOLEAN, &batch, "batch", 0, 0 },
+       { NOTMUCH_OPT_STRING, &input_file_name, "input", 'i', 0 },
+       { 0, 0, 0, 0, 0 }
+    };
 
-       if (synchronize_flags)
-           notmuch_message_tags_to_maildir_flags (message);
+    opt_index = parse_arguments (argc, argv, options, 1);
+    if (opt_index < 0)
+       return 1;
 
-       notmuch_message_destroy (message);
+    if (input_file_name) {
+       batch = TRUE;
+       input = fopen (input_file_name, "r");
+       if (input == NULL) {
+           fprintf (stderr, "Error opening %s for reading: %s\n",
+                    input_file_name, strerror (errno));
+           return 1;
+       }
     }
 
-    notmuch_query_destroy (query);
-    notmuch_database_close (notmuch);
+    if (batch) {
+       if (opt_index != argc) {
+           fprintf (stderr, "Can't specify both cmdline and stdin!\n");
+           return 1;
+       }
+    } else {
+       tag_ops = tag_op_list_create (ctx);
+       if (tag_ops == NULL) {
+           fprintf (stderr, "Out of memory.\n");
+           return 1;
+       }
 
-    return interrupted;
+       if (parse_tag_command_line (ctx, argc - opt_index, argv + opt_index,
+                                   &query_string, tag_ops))
+           return 1;
+    }
+
+    config = notmuch_config_open (ctx, NULL, NULL);
+    if (config == NULL)
+       return 1;
+
+    if (notmuch_database_open (notmuch_config_get_database_path (config),
+                              NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))
+       return 1;
+
+    if (notmuch_config_get_maildir_synchronize_flags (config))
+       tag_flags |= TAG_FLAG_MAILDIR_SYNC;
+
+    if (batch)
+       ret = tag_file (ctx, notmuch, tag_flags, input);
+    else
+       ret = tag_query (ctx, notmuch, query_string, tag_ops, tag_flags);
+
+    notmuch_database_destroy (notmuch);
+
+    if (input != stdin)
+       fclose (input);
+
+    return ret || interrupted;
 }