--- /dev/null
+Return-Path: <m.walters@qmul.ac.uk>\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 9CB5B431FAF\r
+ for <notmuch@notmuchmail.org>; Sat, 8 Dec 2012 02:50:49 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -1.098\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5\r
+ tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001,\r
+ NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] 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 jsmlwgyD-j0x for <notmuch@notmuchmail.org>;\r
+ Sat, 8 Dec 2012 02:50:48 -0800 (PST)\r
+Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6])\r
+ (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+ (No client certificate requested)\r
+ by olra.theworths.org (Postfix) with ESMTPS id 41DB2431FAE\r
+ for <notmuch@notmuchmail.org>; Sat, 8 Dec 2012 02:50:48 -0800 (PST)\r
+Received: from smtp.qmul.ac.uk ([138.37.6.40])\r
+ by mail2.qmul.ac.uk with esmtp (Exim 4.71)\r
+ (envelope-from <m.walters@qmul.ac.uk>)\r
+ id 1ThHza-0002ED-8W; Sat, 08 Dec 2012 10:50:46 +0000\r
+Received: from 93-97-24-31.zone5.bethere.co.uk ([93.97.24.31] helo=localhost)\r
+ by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.69)\r
+ (envelope-from <m.walters@qmul.ac.uk>)\r
+ id 1ThHzZ-0006F9-Fm; Sat, 08 Dec 2012 10:50:46 +0000\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: david@tethera.net, notmuch@notmuchmail.org\r
+Subject: Re: [Patch v3b 4/9] tag-util.[ch]: New files for common tagging\r
+ routines\r
+In-Reply-To: <1354843607-17980-5-git-send-email-david@tethera.net>\r
+References: <1354843607-17980-1-git-send-email-david@tethera.net>\r
+ <1354843607-17980-5-git-send-email-david@tethera.net>\r
+User-Agent: Notmuch/0.14+81~g9730584 (http://notmuchmail.org) Emacs/23.4.1\r
+ (x86_64-pc-linux-gnu)\r
+Date: Sat, 08 Dec 2012 10:50:50 +0000\r
+Message-ID: <8738zghl6d.fsf@qmul.ac.uk>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Sender-Host-Address: 93.97.24.31\r
+X-QM-SPAM-Info: Sender has good ham record. :)\r
+X-QM-Body-MD5: 5fdb1b91811a276700a0ddc397160292 (of first 20000 bytes)\r
+X-SpamAssassin-Score: -1.8\r
+X-SpamAssassin-SpamBar: -\r
+X-SpamAssassin-Report: The QM spam filters have analysed this message to\r
+ determine if it is\r
+ spam. We require at least 5.0 points to mark a message as spam.\r
+ This message scored -1.8 points.\r
+ Summary of the scoring: \r
+ * -2.3 RCVD_IN_DNSWL_MED RBL: Sender listed at http://www.dnswl.org/,\r
+ * medium trust\r
+ * [138.37.6.40 listed in list.dnswl.org]\r
+ * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail\r
+ provider * (markwalters1009[at]gmail.com)\r
+ * 0.5 AWL AWL: From: address is in the auto white-list\r
+X-QM-Scan-Virus: ClamAV says the message is clean\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: Sat, 08 Dec 2012 10:50:49 -0000\r
+\r
+On Fri, 07 Dec 2012, david@tethera.net wrote:\r
+> From: David Bremner <bremner@debian.org>\r
+>\r
+> These are meant to be shared between notmuch-tag and notmuch-restore.\r
+>\r
+> The bulk of the routines implement a "tag operation list" abstract\r
+> data type act as a structured representation of a set of tag\r
+> operations (typically coming from a single tag command or line of\r
+> input).\r
+> ---\r
+> Makefile.local | 1 +\r
+> tag-util.c | 278 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++\r
+> tag-util.h | 119 ++++++++++++++++++++++++\r
+> 3 files changed, 398 insertions(+)\r
+> create mode 100644 tag-util.c\r
+> create mode 100644 tag-util.h\r
+>\r
+> diff --git a/Makefile.local b/Makefile.local\r
+> index 2b91946..854867d 100644\r
+> --- a/Makefile.local\r
+> +++ b/Makefile.local\r
+> @@ -274,6 +274,7 @@ notmuch_client_srcs = \\r
+> query-string.c \\r
+> mime-node.c \\r
+> crypto.c \\r
+> + tag-util.c\r
+> \r
+> notmuch_client_modules = $(notmuch_client_srcs:.c=.o)\r
+> \r
+> diff --git a/tag-util.c b/tag-util.c\r
+> new file mode 100644\r
+> index 0000000..932ee7f\r
+> --- /dev/null\r
+> +++ b/tag-util.c\r
+> @@ -0,0 +1,278 @@\r
+> +#include <assert.h>\r
+> +#include "string-util.h"\r
+> +#include "tag-util.h"\r
+> +#include "hex-escape.h"\r
+> +\r
+> +#define TAG_OP_LIST_INITIAL_SIZE 10\r
+> +\r
+> +struct _tag_operation_t {\r
+> + const char *tag;\r
+> + notmuch_bool_t remove;\r
+> +};\r
+> +\r
+> +struct _tag_op_list_t {\r
+> + tag_operation_t *ops;\r
+> + size_t count;\r
+> + size_t size;\r
+> +};\r
+> +\r
+> +int\r
+> +parse_tag_line (void *ctx, char *line,\r
+> + tag_op_flag_t flags,\r
+> + char **query_string,\r
+> + tag_op_list_t *tag_ops)\r
+> +{\r
+> + char *tok = line;\r
+> + size_t tok_len = 0;\r
+> + char *line_for_error = talloc_strdup (ctx, line);\r
+> + int ret = 0;\r
+> +\r
+> + chomp_newline (line);\r
+> +\r
+> + /* remove leading space */\r
+> + while (*tok == ' ' || *tok == '\t')\r
+> + tok++;\r
+> +\r
+> + /* Skip empty and comment lines. */\r
+> + if (*tok == '\0' || *tok == '#') {\r
+> + ret = 1;\r
+> + goto DONE;\r
+> + }\r
+> +\r
+> + tag_op_list_reset (tag_ops);\r
+> +\r
+> + /* Parse tags. */\r
+> + while ((tok = strtok_len (tok + tok_len, " ", &tok_len)) != NULL) {\r
+> + notmuch_bool_t remove;\r
+> + char *tag;\r
+> +\r
+> + /* Optional explicit end of tags marker. */\r
+> + if (tok_len == 2 && strncmp (tok, "--", tok_len) == 0) {\r
+> + tok = strtok_len (tok + tok_len, " ", &tok_len);\r
+> + break;\r
+> + }\r
+> +\r
+> + /* Implicit end of tags. */\r
+> + if (*tok != '-' && *tok != '+')\r
+> + break;\r
+> +\r
+> + /* If tag is terminated by NUL, there's no query string. */\r
+> + if (*(tok + tok_len) == '\0') {\r
+> + fprintf (stderr, "no query string: %s\n", line_for_error);\r
+> + ret = 1;\r
+> + goto DONE;\r
+> + }\r
+> +\r
+> + /* Terminate, and start next token after terminator. */\r
+> + *(tok + tok_len++) = '\0';\r
+> +\r
+> + remove = (*tok == '-');\r
+> + tag = tok + 1;\r
+> +\r
+> + /* Maybe refuse empty tags. */\r
+> + if (! (flags & TAG_FLAG_BE_GENEROUS) && *tag == '\0') {\r
+> + fprintf (stderr, "Error: empty tag: %s\n", line_for_error);\r
+> + goto DONE;\r
+> + }\r
+> +\r
+> + /* Decode tag. */\r
+> + if (hex_decode_inplace (tag) != HEX_SUCCESS) {\r
+> + fprintf (stderr, "Hex decoding of tag %s failed\n",\r
+> + tag);\r
+> + ret = 1;\r
+> + goto DONE;\r
+> + }\r
+> +\r
+> + if (tag_op_list_append (ctx, tag_ops, tag, remove)) {\r
+> + ret = -1;\r
+> + goto DONE;\r
+> + }\r
+> + }\r
+> +\r
+> + if (tok == NULL) {\r
+> + fprintf (stderr, "Warning: Ignoring invalid input line: %s\n",\r
+> + line_for_error);\r
+> + ret = 1;\r
+> + goto DONE;\r
+> + }\r
+> +\r
+> + /* tok now points to the query string */\r
+> + if (hex_decode_inplace (tok) != HEX_SUCCESS) {\r
+> + fprintf (stderr, "Hex decoding of query %s failed\n",\r
+> + tok);\r
+\r
+\r
+For these hex_decode errors would it be worth printing the full line as\r
+well as the bit that fails hex_decode? Perhaps put something under DONE:\r
+to print the whole line if ret is not success?\r
+\r
+Otherwise LGTM\r
+\r
+Mark\r
+\r
+\r
+> + ret = 1;\r
+> + goto DONE;\r
+> + }\r
+> +\r
+> + *query_string = tok;\r
+> + DONE:\r
+> + talloc_free (line_for_error);\r
+> + return ret;\r
+> +}\r
+> +\r
+> +static inline void\r
+> +message_error (notmuch_message_t *message,\r
+> + notmuch_status_t status,\r
+> + const char *format, ...)\r
+> +{\r
+> + va_list va_args;\r
+> +\r
+> + va_start (va_args, format);\r
+> +\r
+> + vfprintf (stderr, format, va_args);\r
+> + fprintf (stderr, "Message-ID: %s\n", notmuch_message_get_message_id (message));\r
+> + fprintf (stderr, "Status: %s\n", notmuch_status_to_string (status));\r
+> +}\r
+> +\r
+> +notmuch_status_t\r
+> +tag_op_list_apply (notmuch_message_t *message,\r
+> + tag_op_list_t *list,\r
+> + tag_op_flag_t flags)\r
+> +{\r
+> + size_t i;\r
+> + notmuch_status_t status = 0;\r
+> + tag_operation_t *tag_ops = list->ops;\r
+> +\r
+> + status = notmuch_message_freeze (message);\r
+> + if (status) {\r
+> + message_error (message, status, "freezing message");\r
+> + return status;\r
+> + }\r
+> +\r
+> + if (flags & TAG_FLAG_REMOVE_ALL) {\r
+> + status = notmuch_message_remove_all_tags (message);\r
+> + if (status) {\r
+> + message_error (message, status, "removing all tags");\r
+> + return status;\r
+> + }\r
+> + }\r
+> +\r
+> + for (i = 0; i < list->count; i++) {\r
+> + if (tag_ops[i].remove) {\r
+> + status = notmuch_message_remove_tag (message, tag_ops[i].tag);\r
+> + if (status) {\r
+> + message_error (message, status, "removing tag %s", tag_ops[i].tag);\r
+> + return status;\r
+> + }\r
+> + } else {\r
+> + status = notmuch_message_add_tag (message, tag_ops[i].tag);\r
+> + if (status) {\r
+> + message_error (message, status, "adding tag %s", tag_ops[i].tag);\r
+> + return status;\r
+> + }\r
+> +\r
+> + }\r
+> + }\r
+> +\r
+> + status = notmuch_message_thaw (message);\r
+> + if (status) {\r
+> + message_error (message, status, "thawing message");\r
+> + return status;\r
+> + }\r
+> +\r
+> +\r
+> + if (flags & TAG_FLAG_MAILDIR_SYNC) {\r
+> + status = notmuch_message_tags_to_maildir_flags (message);\r
+> + if (status) {\r
+> + message_error (message, status, "synching tags to maildir");\r
+> + return status;\r
+> + }\r
+> + }\r
+> +\r
+> + return NOTMUCH_STATUS_SUCCESS;\r
+> +\r
+> +}\r
+> +\r
+> +\r
+> +/* Array of tagging operations (add or remove. Size will be increased\r
+> + * as necessary. */\r
+> +\r
+> +tag_op_list_t *\r
+> +tag_op_list_create (void *ctx)\r
+> +{\r
+> + tag_op_list_t *list;\r
+> +\r
+> + list = talloc (ctx, tag_op_list_t);\r
+> + if (list == NULL)\r
+> + return NULL;\r
+> +\r
+> + list->size = TAG_OP_LIST_INITIAL_SIZE;\r
+> + list->count = 0;\r
+> +\r
+> + list->ops = talloc_array (ctx, tag_operation_t, list->size);\r
+> + if (list->ops == NULL)\r
+> + return NULL;\r
+> +\r
+> + return list;\r
+> +}\r
+> +\r
+> +\r
+> +int\r
+> +tag_op_list_append (void *ctx,\r
+> + tag_op_list_t *list,\r
+> + const char *tag,\r
+> + notmuch_bool_t remove)\r
+> +{\r
+> + /* Make room if current array is full. This should be a fairly\r
+> + * rare case, considering the initial array size.\r
+> + */\r
+> +\r
+> + if (list->count == list->size) {\r
+> + list->size *= 2;\r
+> + list->ops = talloc_realloc (ctx, list->ops, tag_operation_t,\r
+> + list->size);\r
+> + if (list->ops == NULL) {\r
+> + fprintf (stderr, "Out of memory.\n");\r
+> + return 1;\r
+> + }\r
+> + }\r
+> +\r
+> + /* add the new operation */\r
+> +\r
+> + list->ops[list->count].tag = tag;\r
+> + list->ops[list->count].remove = remove;\r
+> + list->count++;\r
+> + return 0;\r
+> +}\r
+> +\r
+> +/*\r
+> + * Is the i'th tag operation a remove?\r
+> + */\r
+> +\r
+> +notmuch_bool_t\r
+> +tag_op_list_isremove (const tag_op_list_t *list, size_t i)\r
+> +{\r
+> + assert (i < list->count);\r
+> + return list->ops[i].remove;\r
+> +}\r
+> +\r
+> +/*\r
+> + * Reset a list to contain no operations\r
+> + */\r
+> +\r
+> +void\r
+> +tag_op_list_reset (tag_op_list_t *list)\r
+> +{\r
+> + list->count = 0;\r
+> +}\r
+> +\r
+> +/*\r
+> + * Return the number of operations in a list\r
+> + */\r
+> +\r
+> +size_t\r
+> +tag_op_list_size (const tag_op_list_t *list)\r
+> +{\r
+> + return list->count;\r
+> +}\r
+> +\r
+> +/*\r
+> + * return the i'th tag in the list\r
+> + */\r
+> +\r
+> +const char *\r
+> +tag_op_list_tag (const tag_op_list_t *list, size_t i)\r
+> +{\r
+> + assert (i < list->count);\r
+> + return list->ops[i].tag;\r
+> +}\r
+> diff --git a/tag-util.h b/tag-util.h\r
+> new file mode 100644\r
+> index 0000000..df05d72\r
+> --- /dev/null\r
+> +++ b/tag-util.h\r
+> @@ -0,0 +1,119 @@\r
+> +#ifndef _TAG_UTIL_H\r
+> +#define _TAG_UTIL_H\r
+> +\r
+> +#include "notmuch-client.h"\r
+> +\r
+> +typedef struct _tag_operation_t tag_operation_t;\r
+> +typedef struct _tag_op_list_t tag_op_list_t;\r
+> +\r
+> +/* Use powers of 2 */\r
+> +typedef enum {\r
+> + TAG_FLAG_NONE = 0,\r
+> +\r
+> + /* Operations are synced to maildir, if possible.\r
+> + */\r
+> + TAG_FLAG_MAILDIR_SYNC = (1 << 0),\r
+> +\r
+> + /* Remove all tags from message before applying list.\r
+> + */\r
+> + TAG_FLAG_REMOVE_ALL = (1 << 1),\r
+> +\r
+> + /* Don't try to avoid database operations. Useful when we\r
+> + * know that message passed needs these operations.\r
+> + */\r
+> + TAG_FLAG_PRE_OPTIMIZED = (1 << 2),\r
+> +\r
+> + /* Accept strange tags that might be user error;\r
+> + * intended for use by notmuch-restore.\r
+> + */\r
+> + TAG_FLAG_BE_GENEROUS = (1 << 3)\r
+> +\r
+> +} tag_op_flag_t;\r
+> +\r
+> +/* Parse a string of the following format:\r
+> + *\r
+> + * +<tag>|-<tag> [...] [--] <search-terms>\r
+> + *\r
+> + * Each line is interpreted similarly to "notmuch tag" command line\r
+> + * arguments. The delimiter is one or more spaces ' '. Any characters\r
+> + * in <tag> and <search-terms> MAY be hex encoded with %NN where NN is\r
+> + * the hexadecimal value of the character. Any ' ' and '%' characters\r
+> + * in <tag> and <search-terms> MUST be hex encoded (using %20 and %25,\r
+> + * respectively). Any characters that are not part of <tag> or\r
+> + * <search-terms> MUST NOT be hex encoded.\r
+> + *\r
+> + * Leading and trailing space ' ' is ignored. Empty lines and lines\r
+> + * beginning with '#' are ignored.\r
+> + *\r
+> + * Returns: 0 for OK, 1 for skipped line, -1 for fatal(ish) error.\r
+> + *\r
+> + * Output Parameters:\r
+> + * ops contains a list of tag operations\r
+> + * query_str the search terms.\r
+> + */\r
+> +int\r
+> +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
+> + * Create an empty list of tag operations\r
+> + *\r
+> + * ctx is passed to talloc\r
+> + */\r
+> +\r
+> +tag_op_list_t\r
+> +*tag_op_list_create (void *ctx);\r
+> +\r
+> +/*\r
+> + * Add a tag operation (delete iff remove == TRUE) to a list.\r
+> + * The list is expanded as necessary.\r
+> + */\r
+> +\r
+> +int\r
+> +tag_op_list_append (void *ctx,\r
+> + tag_op_list_t *list,\r
+> + const char *tag,\r
+> + notmuch_bool_t remove);\r
+> +\r
+> +/*\r
+> + * Apply a list of tag operations, in order, to a given message.\r
+> + *\r
+> + * Flags can be bitwise ORed; see enum above for possibilies.\r
+> + */\r
+> +\r
+> +notmuch_status_t\r
+> +tag_op_list_apply (notmuch_message_t *message,\r
+> + tag_op_list_t *tag_ops,\r
+> + tag_op_flag_t flags);\r
+> +\r
+> +/*\r
+> + * Return the number of operations in a list\r
+> + */\r
+> +\r
+> +size_t\r
+> +tag_op_list_size (const tag_op_list_t *list);\r
+> +\r
+> +/*\r
+> + * Reset a list to contain no operations\r
+> + */\r
+> +\r
+> +void\r
+> +tag_op_list_reset (tag_op_list_t *list);\r
+> +\r
+> +\r
+> + /*\r
+> + * return the i'th tag in the list\r
+> + */\r
+> +\r
+> +const char *\r
+> +tag_op_list_tag (const tag_op_list_t *list, size_t i);\r
+> +\r
+> +/*\r
+> + * Is the i'th tag operation a remove?\r
+> + */\r
+> +\r
+> +notmuch_bool_t\r
+> +tag_op_list_isremove (const tag_op_list_t *list, size_t i);\r
+> +\r
+> +#endif\r
+> -- \r
+> 1.7.10.4\r
+>\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r
projects / notmuch-archives.git / commitdiff