[Patch v2 2/9] notmuch-tag.c: convert to use tag-utils
Jani Nikula
jani at nikula.org
Mon Jan 7 10:52:02 PST 2013
On Mon, 07 Jan 2013, david at tethera.net wrote:
> From: David Bremner <bremner at debian.org>
>
> Command line parsing is factored out into a function
> parse_tag_command_line in tag-utils.c.
>
> There is some duplicated code eliminated in tag_query, and a bunch of
> translation from using the bare tag_op structs to using that tag-utils
> API.
> ---
> notmuch-tag.c | 99 ++++++++++++---------------------------------------------
> tag-util.c | 51 +++++++++++++++++++++++++++--
> tag-util.h | 15 +++++++++
> 3 files changed, 84 insertions(+), 81 deletions(-)
>
> diff --git a/notmuch-tag.c b/notmuch-tag.c
> index fc9d43a..8129912 100644
> --- a/notmuch-tag.c
> +++ b/notmuch-tag.c
> @@ -19,6 +19,7 @@
> */
>
> #include "notmuch-client.h"
> +#include "tag-util.h"
> #include "string-util.h"
>
> static volatile sig_atomic_t interrupted;
> @@ -36,14 +37,10 @@ handle_sigint (unused (int sig))
> interrupted = 1;
> }
>
> -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,
> @@ -60,7 +57,7 @@ _optimize_tag_query (void *ctx, const char *orig_query_string,
> 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);
>
> /* Build the new query string */
> @@ -69,17 +66,17 @@ _optimize_tag_query (void *ctx, const char *orig_query_string,
> 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_ops[i].tag,
> + "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_ops[i].remove ? "" : "not ",
> + tag_op_list_isremove (list, i) ? "" : "not ",
> escaped);
> join = " or ";
> }
> @@ -91,17 +88,15 @@ _optimize_tag_query (void *ctx, const char *orig_query_string,
> 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. */
> +/* Tag messages matching 'query_string' according to 'tag_ops'
> + */
> static int
> tag_query (void *ctx, notmuch_database_t *notmuch, const char *query_string,
> - tag_operation_t *tag_ops, notmuch_bool_t synchronize_flags)
> + tag_op_list_t *tag_ops, tag_op_flag_t 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. */
> @@ -124,21 +119,7 @@ tag_query (void *ctx, notmuch_database_t *notmuch, const char *query_string,
> 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);
> -
> + tag_op_list_apply (message, tag_ops, flags | TAG_FLAG_PRE_OPTIMIZED);
I think we probably want to check for errors and bail out on them
here. It's a functional change, so it belongs in a follow-up patch. We
haven't done it before, but it'll be more important with batch tagging.
BR,
Jani.
> notmuch_message_destroy (message);
> }
>
> @@ -150,15 +131,13 @@ tag_query (void *ctx, notmuch_database_t *notmuch, const char *query_string,
> int
> notmuch_tag_command (void *ctx, int argc, char *argv[])
> {
> - tag_operation_t *tag_ops;
> - int tag_ops_count = 0;
> - char *query_string;
> + tag_op_list_t *tag_ops = NULL;
> + char *query_string = NULL;
> notmuch_config_t *config;
> notmuch_database_t *notmuch;
> struct sigaction action;
> - notmuch_bool_t synchronize_flags;
> - int i;
> - int ret;
> + tag_op_flag_t tag_flags = TAG_FLAG_NONE;
> + int ret = 0;
>
> /* Setup our handler for SIGINT */
> memset (&action, 0, sizeof (struct sigaction));
> @@ -167,54 +146,15 @@ notmuch_tag_command (void *ctx, int argc, char *argv[])
> 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);
> + 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;
> - }
> - 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;
> - }
> - }
> -
> - 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;
> - }
> -
> - 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");
> + if (parse_tag_command_line (ctx, argc - 1, argv + 1,
> + &query_string, tag_ops))
> return 1;
> - }
>
> config = notmuch_config_open (ctx, NULL, NULL);
> if (config == NULL)
> @@ -224,9 +164,10 @@ notmuch_tag_command (void *ctx, int argc, char *argv[])
> NOTMUCH_DATABASE_MODE_READ_WRITE, ¬much))
> return 1;
>
> - synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);
> + if (notmuch_config_get_maildir_synchronize_flags (config))
> + tag_flags |= TAG_FLAG_MAILDIR_SYNC;
>
> - ret = tag_query (ctx, notmuch, query_string, tag_ops, synchronize_flags);
> + ret = tag_query (ctx, notmuch, query_string, tag_ops, tag_flags);
>
> notmuch_database_destroy (notmuch);
>
> diff --git a/tag-util.c b/tag-util.c
> index 0a4fe78..701d329 100644
> --- a/tag-util.c
> +++ b/tag-util.c
> @@ -45,8 +45,9 @@ illegal_tag (const char *tag, notmuch_bool_t remove)
> if (*tag == '\0' && ! remove)
> return "empty tag forbidden";
>
> - /* This disallows adding the non-removable tag "-" and
> - * enables notmuch tag to take long options more easily.
> + /* This disallows adding tags starting with "-", in particular the
> + * non-removable tag "-" and enables notmuch tag to take long
> + * options more easily.
> */
>
> if (*tag == '-' && ! remove)
> @@ -157,6 +158,52 @@ parse_tag_line (void *ctx, char *line,
> return ret;
> }
>
> +tag_parse_status_t
> +parse_tag_command_line (void *ctx, int argc, char **argv,
> + char **query_str, tag_op_list_t *tag_ops)
> +{
> +
> + int i;
> +
> + tag_op_list_reset (tag_ops);
> +
> + for (i = 0; i < argc; i++) {
> + if (strcmp (argv[i], "--") == 0) {
> + i++;
> + break;
> + }
> +
> + if (argv[i][0] != '+' && argv[i][0] != '-')
> + break;
> +
> + notmuch_bool_t is_remove = argv[i][0] == '-';
> + const char *msg;
> +
> + msg = illegal_tag (argv[i] + 1, is_remove);
> + if (msg) {
> + fprintf (stderr, "Error: %s", msg);
> + return TAG_PARSE_INVALID;
> + }
> +
> + tag_op_list_append (tag_ops, argv[i] + 1, is_remove);
> + }
> +
> + if (tag_op_list_size (tag_ops) == 0) {
> + fprintf (stderr, "Error: 'notmuch tag' requires at least one tag to add or remove.\n");
> + return TAG_PARSE_INVALID;
> + }
> +
> + *query_str = query_string_from_args (ctx, argc - i, &argv[i]);
> +
> + if (*query_str == NULL || **query_str == '\0') {
> + fprintf (stderr, "Error: notmuch tag requires at least one search term.\n");
> + return TAG_PARSE_INVALID;
> + }
> +
> + return TAG_PARSE_SUCCESS;
> +}
> +
> +
> static inline void
> message_error (notmuch_message_t *message,
> notmuch_status_t status,
> diff --git a/tag-util.h b/tag-util.h
> index c07bfde..246de85 100644
> --- a/tag-util.h
> +++ b/tag-util.h
> @@ -72,6 +72,21 @@ parse_tag_line (void *ctx, char *line,
> tag_op_flag_t flags,
> char **query_str, tag_op_list_t *ops);
>
> +
> +
> +/* Parse a command line of the following format:
> + *
> + * +<tag>|-<tag> [...] [--] <search-terms>
> + *
> + * Output Parameters:
> + * ops contains a list of tag operations
> + * query_str the search terms.
> + */
> +
> +tag_parse_status_t
> +parse_tag_command_line (void *ctx, int argc, char **argv,
> + char **query_str, tag_op_list_t *ops);
> +
> /*
> * Create an empty list of tag operations
> *
> --
> 1.7.10.4
>
> _______________________________________________
> notmuch mailing list
> notmuch at notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch
More information about the notmuch
mailing list