Re: [Patch v6 2/6] notmuch-tag.c: convert to use tag-utils
authorJani Nikula <jani@nikula.org>
Mon, 10 Dec 2012 21:51:44 +0000 (23:51 +0200)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:52:00 +0000 (09:52 -0800)
bc/fa91fecd4901233b5e9893c5834285d30b3d28 [new file with mode: 0644]

diff --git a/bc/fa91fecd4901233b5e9893c5834285d30b3d28 b/bc/fa91fecd4901233b5e9893c5834285d30b3d28
new file mode 100644 (file)
index 0000000..620c67d
--- /dev/null
@@ -0,0 +1,381 @@
+Return-Path: <jani@nikula.org>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 1A5F9431FAF\r
+       for <notmuch@notmuchmail.org>; Mon, 10 Dec 2012 13:51:50 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id LimJP3IJywas for <notmuch@notmuchmail.org>;\r
+       Mon, 10 Dec 2012 13:51:49 -0800 (PST)\r
+Received: from mail-lb0-f181.google.com (mail-lb0-f181.google.com\r
+       [209.85.217.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id B2D88431FAE\r
+       for <notmuch@notmuchmail.org>; Mon, 10 Dec 2012 13:51:48 -0800 (PST)\r
+Received: by mail-lb0-f181.google.com with SMTP id ge1so2531934lbb.26\r
+       for <notmuch@notmuchmail.org>; Mon, 10 Dec 2012 13:51:47 -0800 (PST)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=google.com; s=20120113;\r
+       h=from:to:cc:subject:in-reply-to:references:user-agent:date\r
+       :message-id:mime-version:content-type:x-gm-message-state;\r
+       bh=f/OUC3lmB+BLaW8GFoWa5HBczTKKvNvwg0gySxJunZI=;\r
+       b=Y4yoZOR8Y+m3E2aWRbRgIZFVj87OzXJMpQB2FMDo0mk0Ak+J+qQgo1Rfand3TzkQ/i\r
+       tN+Jod93/MWHutEKygxnWc/RJyFqqdRwLpzynJy7zSLpGAsGm84fZqAjz3F3P2eknu7z\r
+       8zuj00MBqMRc4cbLeem+AyJJneSOF5uMfyMr02A+r9fX33rowW/+cZziD3FXEaaknqHT\r
+       KgOQ0a2m+sSILbuu05uadEI8nOr2SOSGCo6PeyURfZOHVvLmjObDeSs2H4MHMzTlXOkT\r
+       BfktRPzMFq1VS3XxwpZwR3rUdDmXEFC9WBOiujeA3TlzbP4fz8SqcKfu93P6bajViazu\r
+       3+9w==\r
+Received: by 10.152.108.42 with SMTP id hh10mr15113564lab.4.1355176307103;\r
+       Mon, 10 Dec 2012 13:51:47 -0800 (PST)\r
+Received: from localhost (dsl-hkibrasgw4-fe51df00-27.dhcp.inet.fi.\r
+       [80.223.81.27])\r
+       by mx.google.com with ESMTPS id gr12sm8400940lab.3.2012.12.10.13.51.45\r
+       (version=SSLv3 cipher=OTHER); Mon, 10 Dec 2012 13:51:46 -0800 (PST)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: david@tethera.net, notmuch@notmuchmail.org\r
+Subject: Re: [Patch v6 2/6] notmuch-tag.c: convert to use tag-utils\r
+In-Reply-To: <1355096008-4544-3-git-send-email-david@tethera.net>\r
+References: <1355096008-4544-1-git-send-email-david@tethera.net>\r
+       <1355096008-4544-3-git-send-email-david@tethera.net>\r
+User-Agent: Notmuch/0.14+138~g7041c56 (http://notmuchmail.org) Emacs/23.4.1\r
+       (i686-pc-linux-gnu)\r
+Date: Mon, 10 Dec 2012 23:51:44 +0200\r
+Message-ID: <876249a83z.fsf@nikula.org>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Gm-Message-State:\r
+ ALoCoQkM8H3R9FPmyJBWB8sdXMtLKBBwo82Ok0pLR6q91VT5glClMDnvxwwExclWrkRDKqU5A/o6\r
+Cc: David Bremner <bremner@debian.org>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Mon, 10 Dec 2012 21:51:50 -0000\r
+\r
+On Mon, 10 Dec 2012, david@tethera.net wrote:\r
+> From: David Bremner <bremner@debian.org>\r
+>\r
+> Command line parsing is factored out into a function\r
+> parse_tag_command_line in tag-utils.c.\r
+>\r
+> There is some duplicated code eliminated in tag_query, and a bunch of\r
+> translation from using the bare tag_op structs to using that tag-utils\r
+> API.\r
+> ---\r
+>  notmuch-tag.c |  104 +++++++++++++--------------------------------------------\r
+>  tag-util.c    |   48 ++++++++++++++++++++++++++\r
+>  tag-util.h    |   16 +++++++++\r
+>  3 files changed, 87 insertions(+), 81 deletions(-)\r
+>\r
+> diff --git a/notmuch-tag.c b/notmuch-tag.c\r
+> index 88d559b..b5cd578 100644\r
+> --- a/notmuch-tag.c\r
+> +++ b/notmuch-tag.c\r
+> @@ -19,6 +19,7 @@\r
+>   */\r
+>  \r
+>  #include "notmuch-client.h"\r
+> +#include "tag-util.h"\r
+>  \r
+>  static volatile sig_atomic_t interrupted;\r
+>  \r
+> @@ -54,14 +55,9 @@ _escape_tag (char *buf, const char *tag)\r
+>      return buf;\r
+>  }\r
+>  \r
+> -typedef struct {\r
+> -    const char *tag;\r
+> -    notmuch_bool_t remove;\r
+> -} tag_operation_t;\r
+> -\r
+>  static char *\r
+>  _optimize_tag_query (void *ctx, const char *orig_query_string,\r
+> -                 const tag_operation_t *tag_ops)\r
+> +                 const tag_op_list_t *list)\r
+>  {\r
+>      /* This is subtler than it looks.  Xapian ignores the '-' operator\r
+>       * at the beginning both queries and parenthesized groups and,\r
+> @@ -73,19 +69,20 @@ _optimize_tag_query (void *ctx, const char *orig_query_string,\r
+>  \r
+>      char *escaped, *query_string;\r
+>      const char *join = "";\r
+> -    int i;\r
+> +    size_t i;\r
+>      unsigned int max_tag_len = 0;\r
+>  \r
+>      /* Don't optimize if there are no tag changes. */\r
+> -    if (tag_ops[0].tag == NULL)\r
+> +    if (tag_op_list_size (list) == 0)\r
+>      return talloc_strdup (ctx, orig_query_string);\r
+>  \r
+>      /* Allocate a buffer for escaping tags.  This is large enough to\r
+>       * hold a fully escaped tag with every character doubled plus\r
+>       * enclosing quotes and a NUL. */\r
+> -    for (i = 0; tag_ops[i].tag; i++)\r
+> -    if (strlen (tag_ops[i].tag) > max_tag_len)\r
+> -        max_tag_len = strlen (tag_ops[i].tag);\r
+> +    for (i = 0; i < tag_op_list_size (list); i++)\r
+> +    if (strlen (tag_op_list_tag (list, i)) > max_tag_len)\r
+> +        max_tag_len = strlen (tag_op_list_tag (list, i));\r
+> +\r
+>      escaped = talloc_array (ctx, char, max_tag_len * 2 + 3);\r
+>      if (! escaped)\r
+>      return NULL;\r
+> @@ -96,11 +93,11 @@ _optimize_tag_query (void *ctx, const char *orig_query_string,\r
+>      else\r
+>      query_string = talloc_asprintf (ctx, "( %s ) and (", orig_query_string);\r
+>  \r
+> -    for (i = 0; tag_ops[i].tag && query_string; i++) {\r
+> +    for (i = 0; i < tag_op_list_size (list) && query_string; i++) {\r
+>      query_string = talloc_asprintf_append_buffer (\r
+>          query_string, "%s%stag:%s", join,\r
+> -        tag_ops[i].remove ? "" : "not ",\r
+> -        _escape_tag (escaped, tag_ops[i].tag));\r
+> +        tag_op_list_isremove (list, i) ? "" : "not ",\r
+> +        _escape_tag (escaped, tag_op_list_tag (list, i)));\r
+>      join = " or ";\r
+>      }\r
+>  \r
+> @@ -116,12 +113,11 @@ _optimize_tag_query (void *ctx, const char *orig_query_string,\r
+>   * element. */\r
+\r
+The comment "array of tagging operations terminated with an empty\r
+element" needs revision too.\r
+\r
+BR,\r
+Jani.\r
+\r
+>  static int\r
+>  tag_query (void *ctx, notmuch_database_t *notmuch, const char *query_string,\r
+> -       tag_operation_t *tag_ops, notmuch_bool_t synchronize_flags)\r
+> +       tag_op_list_t *tag_ops, tag_op_flag_t flags)\r
+>  {\r
+>      notmuch_query_t *query;\r
+>      notmuch_messages_t *messages;\r
+>      notmuch_message_t *message;\r
+> -    int i;\r
+>  \r
+>      /* Optimize the query so it excludes messages that already have\r
+>       * the specified set of tags. */\r
+> @@ -144,21 +140,7 @@ tag_query (void *ctx, notmuch_database_t *notmuch, const char *query_string,\r
+>       notmuch_messages_valid (messages) && ! interrupted;\r
+>       notmuch_messages_move_to_next (messages)) {\r
+>      message = notmuch_messages_get (messages);\r
+> -\r
+> -    notmuch_message_freeze (message);\r
+> -\r
+> -    for (i = 0; tag_ops[i].tag; i++) {\r
+> -        if (tag_ops[i].remove)\r
+> -            notmuch_message_remove_tag (message, tag_ops[i].tag);\r
+> -        else\r
+> -            notmuch_message_add_tag (message, tag_ops[i].tag);\r
+> -    }\r
+> -\r
+> -    notmuch_message_thaw (message);\r
+> -\r
+> -    if (synchronize_flags)\r
+> -        notmuch_message_tags_to_maildir_flags (message);\r
+> -\r
+> +    tag_op_list_apply (message, tag_ops, flags | TAG_FLAG_PRE_OPTIMIZED);\r
+>      notmuch_message_destroy (message);\r
+>      }\r
+>  \r
+> @@ -170,15 +152,13 @@ tag_query (void *ctx, notmuch_database_t *notmuch, const char *query_string,\r
+>  int\r
+>  notmuch_tag_command (void *ctx, int argc, char *argv[])\r
+>  {\r
+> -    tag_operation_t *tag_ops;\r
+> -    int tag_ops_count = 0;\r
+> -    char *query_string;\r
+> +    tag_op_list_t *tag_ops = NULL;\r
+> +    char *query_string = NULL;\r
+>      notmuch_config_t *config;\r
+>      notmuch_database_t *notmuch;\r
+>      struct sigaction action;\r
+> -    notmuch_bool_t synchronize_flags;\r
+> -    int i;\r
+> -    int ret;\r
+> +    tag_op_flag_t tag_flags = TAG_FLAG_NONE;\r
+> +    int ret = 0;\r
+>  \r
+>      /* Setup our handler for SIGINT */\r
+>      memset (&action, 0, sizeof (struct sigaction));\r
+> @@ -187,54 +167,15 @@ notmuch_tag_command (void *ctx, int argc, char *argv[])\r
+>      action.sa_flags = SA_RESTART;\r
+>      sigaction (SIGINT, &action, NULL);\r
+>  \r
+> -    argc--; argv++; /* skip subcommand argument */\r
+> -\r
+> -    /* Array of tagging operations (add or remove), terminated with an\r
+> -     * empty element. */\r
+> -    tag_ops = talloc_array (ctx, tag_operation_t, argc + 1);\r
+> +    tag_ops = tag_op_list_create (ctx);\r
+>      if (tag_ops == NULL) {\r
+>      fprintf (stderr, "Out of memory.\n");\r
+>      return 1;\r
+>      }\r
+>  \r
+> -    for (i = 0; i < argc; i++) {\r
+> -    if (strcmp (argv[i], "--") == 0) {\r
+> -        i++;\r
+> -        break;\r
+> -    }\r
+> -    if (argv[i][0] == '+' || argv[i][0] == '-') {\r
+> -        if (argv[i][0] == '+' && argv[i][1] == '\0') {\r
+> -            fprintf (stderr, "Error: tag names cannot be empty.\n");\r
+> -            return 1;\r
+> -        }\r
+> -        if (argv[i][0] == '+' && argv[i][1] == '-') {\r
+> -            /* This disallows adding the non-removable tag "-" and\r
+> -             * enables notmuch tag to take long options in the\r
+> -             * future. */\r
+> -            fprintf (stderr, "Error: tag names must not start with '-'.\n");\r
+> -            return 1;\r
+> -        }\r
+> -        tag_ops[tag_ops_count].tag = argv[i] + 1;\r
+> -        tag_ops[tag_ops_count].remove = (argv[i][0] == '-');\r
+> -        tag_ops_count++;\r
+> -    } else {\r
+> -        break;\r
+> -    }\r
+> -    }\r
+> -\r
+> -    tag_ops[tag_ops_count].tag = NULL;\r
+> -\r
+> -    if (tag_ops_count == 0) {\r
+> -    fprintf (stderr, "Error: 'notmuch tag' requires at least one tag to add or remove.\n");\r
+> -    return 1;\r
+> -    }\r
+> -\r
+> -    query_string = query_string_from_args (ctx, argc - i, &argv[i]);\r
+> -\r
+> -    if (*query_string == '\0') {\r
+> -    fprintf (stderr, "Error: notmuch tag requires at least one search term.\n");\r
+> +    if (parse_tag_command_line (ctx, argc - 1, argv + 1,\r
+> +                            0, &query_string, tag_ops))\r
+>      return 1;\r
+> -    }\r
+>  \r
+>      config = notmuch_config_open (ctx, NULL, NULL);\r
+>      if (config == NULL)\r
+> @@ -244,9 +185,10 @@ notmuch_tag_command (void *ctx, int argc, char *argv[])\r
+>                             NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))\r
+>      return 1;\r
+>  \r
+> -    synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);\r
+> +    if (notmuch_config_get_maildir_synchronize_flags (config))\r
+> +    tag_flags |= TAG_FLAG_MAILDIR_SYNC;\r
+>  \r
+> -    ret = tag_query (ctx, notmuch, query_string, tag_ops, synchronize_flags);\r
+> +    ret = tag_query (ctx, notmuch, query_string, tag_ops, tag_flags);\r
+>  \r
+>      notmuch_database_destroy (notmuch);\r
+>  \r
+> diff --git a/tag-util.c b/tag-util.c\r
+> index c071ea8..6e3c069 100644\r
+> --- a/tag-util.c\r
+> +++ b/tag-util.c\r
+> @@ -162,6 +162,54 @@ parse_tag_line (void *ctx, char *line,\r
+>      return ret;\r
+>  }\r
+>  \r
+> +int\r
+> +parse_tag_command_line (void *ctx, int argc, char **argv,\r
+> +                    unused(tag_op_flag_t flags),\r
+> +                    char **query_str, tag_op_list_t *tag_ops){\r
+> +\r
+> +    int i;\r
+> +\r
+> +    tag_op_list_reset(tag_ops);\r
+> +\r
+> +    for (i = 0; i < argc; i++) {\r
+> +    if (strcmp (argv[i], "--") == 0) {\r
+> +        i++;\r
+> +        break;\r
+> +    }\r
+> +\r
+> +    if (argv[i][0] == '+' || argv[i][0] == '-') {\r
+> +        notmuch_bool_t is_remove = argv[i][0] == '-';\r
+> +        const char *msg;\r
+> +\r
+> +        msg = illegal_tag(argv[i]+1, is_remove);\r
+> +        if (msg) {\r
+> +            fprintf (stderr, "Error: %s", msg);\r
+> +            return 1;\r
+> +        }\r
+> +\r
+> +        tag_op_list_append (ctx, tag_ops,\r
+> +                            argv[i] + 1, (argv[i][0] == '-'));\r
+> +    } else {\r
+> +        break;\r
+> +    }\r
+> +    }\r
+> +\r
+> +    if (tag_op_list_size (tag_ops) == 0) {\r
+> +    fprintf (stderr, "Error: 'notmuch tag' requires at least one tag to add or remove.\n");\r
+> +    return 1;\r
+> +    }\r
+> +\r
+> +    *query_str = query_string_from_args (ctx, argc - i, &argv[i]);\r
+> +\r
+> +    if (**query_str == '\0') {\r
+> +    fprintf (stderr, "Error: notmuch tag requires at least one search term.\n");\r
+> +    return 1;\r
+> +    }\r
+> +\r
+> +    return 0;\r
+> +}\r
+> +\r
+> +\r
+>  static inline void\r
+>  message_error (notmuch_message_t *message,\r
+>             notmuch_status_t status,\r
+> diff --git a/tag-util.h b/tag-util.h\r
+> index 99b0fa0..4956725 100644\r
+> --- a/tag-util.h\r
+> +++ b/tag-util.h\r
+> @@ -72,6 +72,22 @@ parse_tag_line (void *ctx, char *line,\r
+>              tag_op_flag_t flags,\r
+>              char **query_str, tag_op_list_t *ops);\r
+>  \r
+> +\r
+> +\r
+> +/* Parse a command line of the following format:\r
+> + *\r
+> + * +<tag>|-<tag> [...] [--] <search-terms>\r
+> + *\r
+> + * Output Parameters:\r
+> + *  ops     contains a list of tag operations\r
+> + *  query_str the search terms.\r
+> + */\r
+> +\r
+> +tag_parse_status_t\r
+> +parse_tag_command_line (void *ctx, int argc, char **argv,\r
+> +                    tag_op_flag_t flags,\r
+> +                    char **query_str, tag_op_list_t *ops);\r
+> +\r
+>  /*\r
+>   * Create an empty list of tag operations\r
+>   *\r
+> -- \r
+> 1.7.10.4\r
+>\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r