X-Git-Url: https://git.cworth.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-tag.c;h=71ff06bffe504325de83fb10fab9b9a1e5eb38c0;hp=7d92ec485eabc7233d176bc2b8374a81bde494c5;hb=HEAD;hpb=f4245aec94815176a52baae57a6c260b2bbae9c2 diff --git a/notmuch-tag.c b/notmuch-tag.c index 7d92ec48..71ff06bf 100644 --- a/notmuch-tag.c +++ b/notmuch-tag.c @@ -13,119 +13,305 @@ * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see http://www.gnu.org/licenses/ . + * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Carl Worth */ #include "notmuch-client.h" +#include "tag-util.h" +#include "string-util.h" static volatile sig_atomic_t interrupted; static void handle_sigint (unused (int sig)) { - static char msg[] = "Stopping... \n"; - write(2, msg, sizeof(msg)-1); + static const char msg[] = "Stopping... \n"; + + /* 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; } -int -notmuch_tag_command (void *ctx, unused (int argc), unused (char *argv[])) + +static char * +_optimize_tag_query_infix (void *ctx, const char *orig_query_string, + 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, + * 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 = NULL; + size_t escaped_len = 0; + char *query_string; + const char *join = ""; + size_t i; + + /* Don't optimize if there are no tag changes. */ + if (tag_op_list_size (list) == 0) + return talloc_strdup (ctx, orig_query_string); + + /* 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; 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%s%s", join, + tag_op_list_isremove (list, i) ? "" : "not ", + escaped); + join = " or "; + } + + if (query_string) + query_string = talloc_strdup_append_buffer (query_string, ")"); + + talloc_free (escaped); + return query_string; +} + +static char * +_optimize_tag_query (void *ctx, const char *orig_query_string, + notmuch_query_syntax_t stx, + const tag_op_list_t *list) { - int *add_tags, *remove_tags; - int add_tags_count = 0; - int remove_tags_count = 0; char *query_string; - notmuch_config_t *config; - notmuch_database_t *notmuch; + + if (stx == NOTMUCH_QUERY_SYNTAX_XAPIAN) + return _optimize_tag_query_infix (ctx, orig_query_string, list); + + /* Don't optimize if there are no tag changes. */ + if (tag_op_list_size (list) == 0) + return talloc_strdup (ctx, orig_query_string); + + query_string = talloc_asprintf (ctx, "(and %s", orig_query_string); + for (size_t i = 0; i < tag_op_list_size (list) && query_string; i++) { + query_string = talloc_asprintf_append_buffer ( + query_string, tag_op_list_isremove (list, i) ? " (tag \"%s\")" : " (not (tag \"%s\"))", + tag_op_list_tag (list, i)); + } + + if (query_string) + query_string = talloc_strdup_append_buffer (query_string, ")"); + + return query_string; +} + +/* 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) +{ notmuch_query_t *query; notmuch_messages_t *messages; notmuch_message_t *message; - struct sigaction action; - int i; + notmuch_status_t status; - /* 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); + int ret = NOTMUCH_STATUS_SUCCESS; - add_tags = talloc_size (ctx, argc * sizeof (int)); - if (add_tags == NULL) { - fprintf (stderr, "Out of memory.\n"); + if (! (flags & TAG_FLAG_REMOVE_ALL)) { + /* Optimize the query so it excludes messages that already + * have the specified set of tags. */ + query_string = _optimize_tag_query (ctx, query_string, + shared_option_query_syntax (), + tag_ops); + if (query_string == NULL) { + fprintf (stderr, "Out of memory.\n"); + return 1; + } + flags |= TAG_FLAG_PRE_OPTIMIZED; + } + + status = notmuch_query_create_with_syntax (notmuch, query_string, + shared_option_query_syntax (), + &query); + if (print_status_database ("notmuch tag", notmuch, status)) return 1; + + /* tagging is not interested in any special sort order */ + notmuch_query_set_sort (query, NOTMUCH_SORT_UNSORTED); + + status = notmuch_query_search_messages (query, &messages); + if (print_status_query ("notmuch tag", query, status)) + return status; + + for (; + notmuch_messages_valid (messages) && ! interrupted; + notmuch_messages_move_to_next (messages)) { + message = notmuch_messages_get (messages); + ret = tag_op_list_apply (message, tag_ops, flags); + notmuch_message_destroy (message); + if (ret != NOTMUCH_STATUS_SUCCESS) + break; } - remove_tags = talloc_size (ctx, argc * sizeof (int)); - if (remove_tags == NULL) { + notmuch_query_destroy (query); + + return ret || interrupted; +} + +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; + int warn = 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; } - for (i = 0; i < argc; i++) { - if (strcmp (argv[i], "--") == 0) { - i++; - break; + while ((line_len = getline (&line, &line_size, input)) != -1 && + ! interrupted) { + + ret = parse_tag_line (ctx, line, TAG_FLAG_NONE, + &query_string, tag_ops); + + if (ret > 0) { + if (ret != TAG_PARSE_SKIPPED) + /* remember there has been problematic lines */ + warn = 1; + ret = 0; + continue; } - if (argv[i][0] == '+') { - add_tags[add_tags_count++] = i; - } else if (argv[i][0] == '-') { - remove_tags[remove_tags_count++] = i; - } else { + + if (ret < 0) break; - } - } - if (add_tags_count == 0 && remove_tags_count == 0) { - fprintf (stderr, "Error: 'notmuch tag' requires at least one tag to add or remove.\n"); - return 1; + ret = tag_query (ctx, notmuch, query_string, tag_ops, flags); + if (ret) + break; } - if (i == argc) { - fprintf (stderr, "Error: 'notmuch tag' requires at least one search term.\n"); - return 1; - } + if (line) + free (line); - config = notmuch_config_open (ctx, NULL, NULL); - if (config == NULL) - return 1; + return ret || warn; +} - notmuch = notmuch_database_open (notmuch_config_get_database_path (config)); - if (notmuch == NULL) - return 1; +int +notmuch_tag_command (notmuch_database_t *notmuch, int argc, char *argv[]) +{ + tag_op_list_t *tag_ops = NULL; + char *query_string = NULL; + struct sigaction action; + tag_op_flag_t tag_flags = TAG_FLAG_NONE; + bool batch = false; + bool remove_all = false; + FILE *input = stdin; + const char *input_file_name = NULL; + int opt_index; + int ret; + notmuch_bool_t synchronize_flags; - query_string = query_string_from_args (ctx, argc - i, &argv[i]); + /* Set up 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); - query = notmuch_query_create (notmuch, query_string); - if (query == NULL) { - fprintf (stderr, "Out of memory.\n"); - return 1; - } + notmuch_opt_desc_t options[] = { + { .opt_bool = &batch, .name = "batch" }, + { .opt_string = &input_file_name, .name = "input" }, + { .opt_bool = &remove_all, .name = "remove-all" }, + { .opt_inherit = notmuch_shared_options }, + { } + }; - for (messages = notmuch_query_search_messages (query, 0, -1); - notmuch_messages_has_more (messages) && !interrupted; - notmuch_messages_advance (messages)) - { - message = notmuch_messages_get (messages); + opt_index = parse_arguments (argc, argv, options, 1); + if (opt_index < 0) + return EXIT_FAILURE; - notmuch_message_freeze (message); + notmuch_process_shared_options (notmuch, argv[0]); - for (i = 0; i < remove_tags_count; i++) - notmuch_message_remove_tag (message, - argv[remove_tags[i]] + 1); + 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 EXIT_FAILURE; + } + } - for (i = 0; i < add_tags_count; i++) - notmuch_message_add_tag (message, argv[add_tags[i]] + 1); + if (batch) { + if (opt_index != argc) { + fprintf (stderr, "Can't specify both cmdline and stdin!\n"); + if (input) + fclose (input); + return EXIT_FAILURE; + } + } else { + tag_ops = tag_op_list_create (notmuch); + if (tag_ops == NULL) { + fprintf (stderr, "Out of memory.\n"); + return EXIT_FAILURE; + } - notmuch_message_thaw (message); + if (parse_tag_command_line (notmuch, argc - opt_index, argv + opt_index, + &query_string, tag_ops)) + return EXIT_FAILURE; - notmuch_message_destroy (message); + if (tag_op_list_size (tag_ops) == 0 && ! remove_all) { + fprintf (stderr, "Error: 'notmuch tag' requires at least one tag to add or remove.\n"); + return EXIT_FAILURE; + } + + if (*query_string == '\0') { + fprintf (stderr, "Error: notmuch tag requires at least one search term.\n"); + return EXIT_FAILURE; + } } - notmuch_query_destroy (query); - notmuch_database_close (notmuch); + if (print_status_database ( + "notmuch restore", + notmuch, + notmuch_config_get_bool (notmuch, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS, + &synchronize_flags))) + return EXIT_FAILURE; + + if (synchronize_flags) + tag_flags |= TAG_FLAG_MAILDIR_SYNC; + + if (remove_all) + tag_flags |= TAG_FLAG_REMOVE_ALL; + + if (batch) + ret = tag_file (notmuch, notmuch, tag_flags, input); + else + ret = tag_query (notmuch, notmuch, query_string, tag_ops, tag_flags); + + notmuch_database_destroy (notmuch); + + if (input != stdin) + fclose (input); - return interrupted; + return ret || interrupted ? EXIT_FAILURE : EXIT_SUCCESS; }