[Patch v2 2/9] notmuch-tag.c: convert to use tag-utils
authordavid <david@tethera.net>
Mon, 7 Jan 2013 03:16:47 +0000 (23:16 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:52:59 +0000 (09:52 -0800)
f9/86c3a175d1b83c24c82479d0d94acfb8676537 [new file with mode: 0644]

diff --git a/f9/86c3a175d1b83c24c82479d0d94acfb8676537 b/f9/86c3a175d1b83c24c82479d0d94acfb8676537
new file mode 100644 (file)
index 0000000..6ef7e06
--- /dev/null
@@ -0,0 +1,359 @@
+Return-Path: <bremner@tethera.net>\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 79EDE429E4E\r
+       for <notmuch@notmuchmail.org>; Sun,  6 Jan 2013 19:17:15 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       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 Kx+WEzEsp9FV for <notmuch@notmuchmail.org>;\r
+       Sun,  6 Jan 2013 19:17:13 -0800 (PST)\r
+Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238])\r
+       (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 1F64F429E27\r
+       for <notmuch@notmuchmail.org>; Sun,  6 Jan 2013 19:17:12 -0800 (PST)\r
+Received: from fctnnbsc30w-156034082078.dhcp-dynamic.fibreop.nb.bellaliant.net\r
+       ([156.34.82.78] helo=zancas.localnet)\r
+       by tesseract.cs.unb.ca with esmtpsa\r
+       (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1Ts3D3-0002dx-1h; Sun, 06 Jan 2013 23:17:09 -0400\r
+Received: from bremner by zancas.localnet with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1Ts3Cx-0001hq-G4; Sun, 06 Jan 2013 23:17:03 -0400\r
+From: david@tethera.net\r
+To: notmuch@notmuchmail.org\r
+Subject: [Patch v2 2/9] notmuch-tag.c: convert to use tag-utils\r
+Date: Sun,  6 Jan 2013 23:16:47 -0400\r
+Message-Id: <1357528614-6413-3-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.7.10.4\r
+In-Reply-To: <1357528614-6413-1-git-send-email-david@tethera.net>\r
+References: <1357528614-6413-1-git-send-email-david@tethera.net>\r
+X-Spam_bar: -\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, 07 Jan 2013 03:17:15 -0000\r
+\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 |   99 ++++++++++++---------------------------------------------\r
+ tag-util.c    |   51 +++++++++++++++++++++++++++--\r
+ tag-util.h    |   15 +++++++++\r
+ 3 files changed, 84 insertions(+), 81 deletions(-)\r
+\r
+diff --git a/notmuch-tag.c b/notmuch-tag.c\r
+index fc9d43a..8129912 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
+ #include "string-util.h"\r
\r
+ static volatile sig_atomic_t interrupted;\r
+@@ -36,14 +37,10 @@ handle_sigint (unused (int sig))\r
+     interrupted = 1;\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
+@@ -60,7 +57,7 @@ _optimize_tag_query (void *ctx, const char *orig_query_string,\r
+     size_t i;\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
+     /* Build the new query string */\r
+@@ -69,17 +66,17 @@ _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
+       /* XXX in case of OOM, query_string will be deallocated when\r
+        * ctx is, which might be at shutdown */\r
+       if (make_boolean_term (ctx,\r
+-                             "tag", tag_ops[i].tag,\r
++                             "tag", tag_op_list_tag (list, i),\r
+                              &escaped, &escaped_len))\r
+           return NULL;\r
\r
+       query_string = talloc_asprintf_append_buffer (\r
+           query_string, "%s%s%s", join,\r
+-          tag_ops[i].remove ? "" : "not ",\r
++          tag_op_list_isremove (list, i) ? "" : "not ",\r
+           escaped);\r
+       join = " or ";\r
+     }\r
+@@ -91,17 +88,15 @@ _optimize_tag_query (void *ctx, const char *orig_query_string,\r
+     return query_string;\r
+ }\r
\r
+-/* Tag messages matching 'query_string' according to 'tag_ops', which\r
+- * must be an array of tagging operations terminated with an empty\r
+- * element. */\r
++/* Tag messages matching 'query_string' according to 'tag_ops'\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
+@@ -124,21 +119,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
+@@ -150,15 +131,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
+@@ -167,54 +146,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
++                              &query_string, tag_ops))\r
+       return 1;\r
+-    }\r
\r
+     config = notmuch_config_open (ctx, NULL, NULL);\r
+     if (config == NULL)\r
+@@ -224,9 +164,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 0a4fe78..701d329 100644\r
+--- a/tag-util.c\r
++++ b/tag-util.c\r
+@@ -45,8 +45,9 @@ illegal_tag (const char *tag, notmuch_bool_t remove)\r
+     if (*tag == '\0' && ! remove)\r
+       return "empty tag forbidden";\r
\r
+-    /* This disallows adding the non-removable tag "-" and\r
+-     * enables notmuch tag to take long options more easily.\r
++    /* This disallows adding tags starting with "-", in particular the\r
++     * non-removable tag "-" and enables notmuch tag to take long\r
++     * options more easily.\r
+      */\r
\r
+     if (*tag == '-' && ! remove)\r
+@@ -157,6 +158,52 @@ parse_tag_line (void *ctx, char *line,\r
+     return ret;\r
+ }\r
\r
++tag_parse_status_t\r
++parse_tag_command_line (void *ctx, int argc, char **argv,\r
++                      char **query_str, tag_op_list_t *tag_ops)\r
++{\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
++          break;\r
++\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 TAG_PARSE_INVALID;\r
++      }\r
++\r
++      tag_op_list_append (tag_ops, argv[i] + 1, is_remove);\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 TAG_PARSE_INVALID;\r
++    }\r
++\r
++    *query_str = query_string_from_args (ctx, argc - i, &argv[i]);\r
++\r
++    if (*query_str == NULL || **query_str == '\0') {\r
++      fprintf (stderr, "Error: notmuch tag requires at least one search term.\n");\r
++      return TAG_PARSE_INVALID;\r
++    }\r
++\r
++    return TAG_PARSE_SUCCESS;\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 c07bfde..246de85 100644\r
+--- a/tag-util.h\r
++++ b/tag-util.h\r
+@@ -72,6 +72,21 @@ 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
++                      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