From d7b5a56dea6fd9dd759791e03afd75f659dc33a9 Mon Sep 17 00:00:00 2001 From: Adam Wolfe Gordon Date: Mon, 19 Mar 2012 10:32:36 +1800 Subject: [PATCH] [PATCH v8 04/11] reply: Add a JSON reply format. --- d0/c587fb05af9e25df40e29dbe1d6372838323df | 275 ++++++++++++++++++++++ 1 file changed, 275 insertions(+) create mode 100644 d0/c587fb05af9e25df40e29dbe1d6372838323df diff --git a/d0/c587fb05af9e25df40e29dbe1d6372838323df b/d0/c587fb05af9e25df40e29dbe1d6372838323df new file mode 100644 index 000000000..c29817186 --- /dev/null +++ b/d0/c587fb05af9e25df40e29dbe1d6372838323df @@ -0,0 +1,275 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 6B29A431FD0 + for ; Sun, 18 Mar 2012 09:33:05 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0 +X-Spam-Level: +X-Spam-Status: No, score=0 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_NONE=-0.0001] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id 29e9aDZZbfj9 for ; + Sun, 18 Mar 2012 09:33:03 -0700 (PDT) +Received: from idcmail-mo1so.shaw.ca (idcmail-mo1so.shaw.ca [24.71.223.10]) + by olra.theworths.org (Postfix) with ESMTP id 1CB59431FD6 + for ; Sun, 18 Mar 2012 09:33:01 -0700 (PDT) +Received: from pd4ml3so-ssvc.prod.shaw.ca ([10.0.141.150]) + by pd4mo1so-svcs.prod.shaw.ca with ESMTP; 18 Mar 2012 10:33:00 -0600 +X-Cloudmark-SP-Filtered: true +X-Cloudmark-SP-Result: v=1.1 cv=b/gStvK98Bs6YfhBwCpxRApoLO2qoBYaarCtclPE+68= + c=1 sm=1 + a=PHNqX133DScA:10 a=BLceEmwcHowA:10 a=yQp6g8lIsgqumF79BAsFDg==:17 + a=bz-zy3QpAAAA:8 a=n6QtOu-G53KnuZUlGJ0A:9 a=_PtZexEyJN9in46kyVIA:7 + a=NFWI-YhVVZsA:10 a=VqgfUknEhrnVsQv5:21 a=7kzdyUmDbSbuI7Hz:21 + a=HpAAvcLHHh0Zw7uRqdWCyQ==:117 +Received: from unknown (HELO lagos.xvx.ca) ([96.52.216.56]) + by pd4ml3so-dmz.prod.shaw.ca with ESMTP; 18 Mar 2012 10:33:00 -0600 +Received: by lagos.xvx.ca (Postfix, from userid 1000) + id 12BB28004838; Sun, 18 Mar 2012 10:33:00 -0600 (MDT) +From: Adam Wolfe Gordon +To: notmuch@notmuchmail.org +Subject: [PATCH v8 04/11] reply: Add a JSON reply format. +Date: Sun, 18 Mar 2012 10:32:36 -0600 +Message-Id: <1332088363-22476-5-git-send-email-awg+notmuch@xvx.ca> +X-Mailer: git-send-email 1.7.5.4 +In-Reply-To: <1332088363-22476-1-git-send-email-awg+notmuch@xvx.ca> +References: <87fwd6kqtv.fsf@zancas.localnet> + <1332088363-22476-1-git-send-email-awg+notmuch@xvx.ca> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sun, 18 Mar 2012 16:33:05 -0000 + +This new JSON format for replies includes headers generated for a +reply message as well as the headers of the original message. Using +this data, a client can intelligently create a reply. For example, the +emacs client will be able to create replies with quoted HTML parts by +parsing the HTML parts. +--- + notmuch-client.h | 12 +++++++++--- + notmuch-reply.c | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ + notmuch-show.c | 29 +++++++++++++++++++++-------- + test/multipart | 1 - + 4 files changed, 79 insertions(+), 12 deletions(-) + +diff --git a/notmuch-client.h b/notmuch-client.h +index a220fe4..fa04fa2 100644 +--- a/notmuch-client.h ++++ b/notmuch-client.h +@@ -62,7 +62,7 @@ + #define STRINGIFY(s) STRINGIFY_(s) + #define STRINGIFY_(s) #s + +-struct mime_node; ++typedef struct mime_node mime_node_t; + struct notmuch_show_params; + + typedef struct notmuch_show_format { +@@ -191,6 +191,12 @@ show_message_body (notmuch_message_t *message, + notmuch_status_t + show_one_part (const char *filename, int part); + ++void ++format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first); ++ ++void ++format_headers_json (const void *ctx, GMimeMessage *message, notmuch_bool_t reply); ++ + char * + json_quote_chararray (const void *ctx, const char *str, const size_t len); + +@@ -288,7 +294,7 @@ debugger_is_active (void); + * parts. Message-type parts have one child, multipart-type parts + * have multiple children, and leaf parts have zero children. + */ +-typedef struct mime_node { ++struct mime_node { + /* The MIME object of this part. This will be a GMimeMessage, + * GMimePart, GMimeMultipart, or a subclass of one of these. + * +@@ -351,7 +357,7 @@ typedef struct mime_node { + * number to assign it (or -1 if unknown). */ + int next_child; + int next_part_num; +-} mime_node_t; ++}; + + /* Construct a new MIME node pointing to the root message part of + * message. If cryptoctx is non-NULL, it will be used to verify +diff --git a/notmuch-reply.c b/notmuch-reply.c +index f1478cc..e2b6c25 100644 +--- a/notmuch-reply.c ++++ b/notmuch-reply.c +@@ -604,6 +604,51 @@ notmuch_reply_format_default(void *ctx, + return 0; + } + ++static int ++notmuch_reply_format_json(void *ctx, ++ notmuch_config_t *config, ++ notmuch_query_t *query, ++ notmuch_show_params_t *params, ++ notmuch_bool_t reply_all) ++{ ++ GMimeMessage *reply; ++ notmuch_messages_t *messages; ++ notmuch_message_t *message; ++ mime_node_t *node; ++ ++ if (notmuch_query_count_messages (query) != 1) { ++ fprintf (stderr, "Error: search term did not match precisely one message.\n"); ++ return 1; ++ } ++ ++ messages = notmuch_query_search_messages (query); ++ message = notmuch_messages_get (messages); ++ if (mime_node_open (ctx, message, params->cryptoctx, params->decrypt, ++ &node) != NOTMUCH_STATUS_SUCCESS) ++ return 1; ++ ++ reply = create_reply_message (ctx, config, message, reply_all); ++ if (!reply) ++ return 1; ++ ++ /* The headers of the reply message we've created */ ++ printf ("{\"reply-headers\": "); ++ format_headers_json (ctx, reply, TRUE); ++ g_object_unref (G_OBJECT (reply)); ++ reply = NULL; ++ ++ /* Start the original */ ++ printf (", \"original\": "); ++ ++ format_part_json (ctx, node, TRUE); ++ ++ /* End */ ++ printf ("}\n"); ++ notmuch_message_destroy (message); ++ ++ return 0; ++} ++ + /* This format is currently tuned for a git send-email --notmuch hook */ + static int + notmuch_reply_format_headers_only(void *ctx, +@@ -666,6 +711,7 @@ notmuch_reply_format_headers_only(void *ctx, + + enum { + FORMAT_DEFAULT, ++ FORMAT_JSON, + FORMAT_HEADERS_ONLY, + }; + +@@ -685,6 +731,7 @@ notmuch_reply_command (void *ctx, int argc, char *argv[]) + notmuch_opt_desc_t options[] = { + { NOTMUCH_OPT_KEYWORD, &format, "format", 'f', + (notmuch_keyword_t []){ { "default", FORMAT_DEFAULT }, ++ { "json", FORMAT_JSON }, + { "headers-only", FORMAT_HEADERS_ONLY }, + { 0, 0 } } }, + { NOTMUCH_OPT_KEYWORD, &reply_all, "reply-to", 'r', +@@ -703,6 +750,8 @@ notmuch_reply_command (void *ctx, int argc, char *argv[]) + + if (format == FORMAT_HEADERS_ONLY) + reply_format_func = notmuch_reply_format_headers_only; ++ else if (format == FORMAT_JSON) ++ reply_format_func = notmuch_reply_format_json; + else + reply_format_func = notmuch_reply_format_default; + +diff --git a/notmuch-show.c b/notmuch-show.c +index a7463dc..ff9d427 100644 +--- a/notmuch-show.c ++++ b/notmuch-show.c +@@ -200,8 +200,8 @@ _is_from_line (const char *line) + return 0; + } + +-static void +-format_headers_json (const void *ctx, GMimeMessage *message) ++void ++format_headers_json (const void *ctx, GMimeMessage *message, notmuch_bool_t reply) + { + void *local = talloc_new (ctx); + InternetAddressList *recipients; +@@ -225,9 +225,22 @@ format_headers_json (const void *ctx, GMimeMessage *message) + printf (", %s: %s", + json_quote_str (local, "Cc"), + json_quote_str (local, recipients_string)); +- printf (", %s: %s}", +- json_quote_str (local, "Date"), +- json_quote_str (local, g_mime_message_get_date_as_string (message))); ++ ++ if (reply) { ++ printf (", %s: %s", ++ json_quote_str (local, "In-reply-to"), ++ json_quote_str (local, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"))); ++ ++ printf (", %s: %s", ++ json_quote_str (local, "References"), ++ json_quote_str (local, g_mime_object_get_header (GMIME_OBJECT (message), "References"))); ++ } else { ++ printf (", %s: %s", ++ json_quote_str (local, "Date"), ++ json_quote_str (local, g_mime_message_get_date_as_string (message))); ++ } ++ ++ printf ("}"); + + talloc_free (local); + } +@@ -538,7 +551,7 @@ format_part_text (const void *ctx, mime_node_t *node, + return NOTMUCH_STATUS_SUCCESS; + } + +-static void ++void + format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first) + { + /* Any changes to the JSON format should be reflected in the file +@@ -549,7 +562,7 @@ format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first) + format_message_json (ctx, node->envelope_file); + + printf ("\"headers\": "); +- format_headers_json (ctx, GMIME_MESSAGE (node->part)); ++ format_headers_json (ctx, GMIME_MESSAGE (node->part), FALSE); + + printf (", \"body\": ["); + format_part_json (ctx, mime_node_child (node, 0), first); +@@ -623,7 +636,7 @@ format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first) + } else if (GMIME_IS_MESSAGE (node->part)) { + printf (", \"content\": [{"); + printf ("\"headers\": "); +- format_headers_json (local, GMIME_MESSAGE (node->part)); ++ format_headers_json (local, GMIME_MESSAGE (node->part), FALSE); + + printf (", \"body\": ["); + terminator = "]}]"; +diff --git a/test/multipart b/test/multipart +index e5de5d3..72d3927 100755 +--- a/test/multipart ++++ b/test/multipart +@@ -613,7 +613,6 @@ EOF + test_expect_equal_file OUTPUT EXPECTED + + test_begin_subtest "'notmuch reply' to a multipart message with json format" +-test_subtest_known_broken + notmuch reply --format=json 'id:87liy5ap00.fsf@yoom.home.cworth.org' | notmuch_json_show_sanitize >OUTPUT + cat <EXPECTED + {"reply-headers": {"Subject": "Re: Multipart message", +-- +1.7.5.4 + -- 2.26.2