From 143050ac3a963b8233372f953dfd5cff66441f60 Mon Sep 17 00:00:00 2001 From: Adam Wolfe Gordon Date: Wed, 15 Feb 2012 22:42:15 +1700 Subject: [PATCH] [PATCH v5.1 2/4] reply: Add a JSON reply format. --- c7/7b6f6f79cd72ecf4b735dd4844174504c058f9 | 342 ++++++++++++++++++++++ 1 file changed, 342 insertions(+) create mode 100644 c7/7b6f6f79cd72ecf4b735dd4844174504c058f9 diff --git a/c7/7b6f6f79cd72ecf4b735dd4844174504c058f9 b/c7/7b6f6f79cd72ecf4b735dd4844174504c058f9 new file mode 100644 index 000000000..575cb1e7a --- /dev/null +++ b/c7/7b6f6f79cd72ecf4b735dd4844174504c058f9 @@ -0,0 +1,342 @@ +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 656C1431FBD + for ; Tue, 14 Feb 2012 21:42:19 -0800 (PST) +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 DvAkOkkaYraS for ; + Tue, 14 Feb 2012 21:42:18 -0800 (PST) +Received: from idcmail-mo1so.shaw.ca (idcmail-mo1so.shaw.ca [24.71.223.10]) + by olra.theworths.org (Postfix) with ESMTP id 59F56431FBC + for ; Tue, 14 Feb 2012 21:42:18 -0800 (PST) +Received: from pd3ml1so-ssvc.prod.shaw.ca ([10.0.141.140]) + by pd3mo1so-svcs.prod.shaw.ca with ESMTP; 14 Feb 2012 22:42:17 -0700 +X-Cloudmark-SP-Filtered: true +X-Cloudmark-SP-Result: v=1.1 cv=MPNiKFfsidoaPqBs0kThsodqbsbgvPHp5CGEg9DOvhI= + c=1 sm=1 + a=WZU82kzV3_QA:10 a=BLceEmwcHowA:10 a=yQp6g8lIsgqumF79BAsFDg==:17 + a=3-z4jJ9MB81Z5CkkUWIA:9 a=7RHqQ3Bl_oONjem5DEkA:7 a=4tDw8iMZ7BjuzbIB:21 + a=nVwLb1l9P6mUoZsG:21 a=HpAAvcLHHh0Zw7uRqdWCyQ==:117 +Received: from unknown (HELO lagos.xvx.ca) ([96.52.216.56]) + by pd3ml1so-dmz.prod.shaw.ca with ESMTP; 14 Feb 2012 22:42:17 -0700 +Received: by lagos.xvx.ca (Postfix, from userid 1000) + id 5448B8004EBA; Tue, 14 Feb 2012 22:42:17 -0700 (MST) +From: Adam Wolfe Gordon +To: notmuch@notmuchmail.org +Subject: [PATCH v5.1 2/4] reply: Add a JSON reply format. +Date: Tue, 14 Feb 2012 22:42:15 -0700 +Message-Id: <1329284535-2140-1-git-send-email-awg+notmuch@xvx.ca> +X-Mailer: git-send-email 1.7.5.4 +In-Reply-To: <1329282027-29457-3-git-send-email-awg+notmuch@xvx.ca> +References: <1329282027-29457-3-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: Wed, 15 Feb 2012 05:42:19 -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. + +Reply now enforces that only one message is returned, as the semantics +of replying to multiple messages are not well-defined. +--- + +Adjusted the header display to be consistent with the other JSON formats. + + notmuch-client.h | 3 + + notmuch-reply.c | 188 +++++++++++++++++++++++++++++++++++++++++------------ + notmuch-show.c | 2 +- + 3 files changed, 149 insertions(+), 44 deletions(-) + +diff --git a/notmuch-client.h b/notmuch-client.h +index 60828aa..d28ea07 100644 +--- a/notmuch-client.h ++++ b/notmuch-client.h +@@ -344,6 +344,9 @@ typedef struct mime_node { + int next_part_num; + } mime_node_t; + ++void ++format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first); ++ + /* Construct a new MIME node pointing to the root message part of + * message. If cryptoctx is non-NULL, it will be used to verify + * signatures on any child parts. If decrypt is true, then cryptoctx +diff --git a/notmuch-reply.c b/notmuch-reply.c +index 6b244e6..76995b1 100644 +--- a/notmuch-reply.c ++++ b/notmuch-reply.c +@@ -505,6 +505,61 @@ guess_from_received_header (notmuch_config_t *config, notmuch_message_t *message + return NULL; + } + ++static GMimeMessage * ++create_reply_message(void *ctx, ++ notmuch_config_t *config, ++ notmuch_message_t *message, ++ notmuch_bool_t reply_all) ++{ ++ const char *subject, *from_addr = NULL; ++ const char *in_reply_to, *orig_references, *references; ++ ++ /* The 1 means we want headers in a "pretty" order. */ ++ GMimeMessage *reply = g_mime_message_new (1); ++ if (reply == NULL) { ++ fprintf (stderr, "Out of memory\n"); ++ return NULL; ++ } ++ ++ subject = notmuch_message_get_header (message, "subject"); ++ if (subject) { ++ if (strncasecmp (subject, "Re:", 3)) ++ subject = talloc_asprintf (ctx, "Re: %s", subject); ++ g_mime_message_set_subject (reply, subject); ++ } ++ ++ from_addr = add_recipients_from_message (reply, config, ++ message, reply_all); ++ ++ if (from_addr == NULL) ++ from_addr = guess_from_received_header (config, message); ++ ++ if (from_addr == NULL) ++ from_addr = notmuch_config_get_user_primary_email (config); ++ ++ from_addr = talloc_asprintf (ctx, "%s <%s>", ++ notmuch_config_get_user_name (config), ++ from_addr); ++ g_mime_object_set_header (GMIME_OBJECT (reply), ++ "From", from_addr); ++ ++ in_reply_to = talloc_asprintf (ctx, "<%s>", ++ notmuch_message_get_message_id (message)); ++ ++ g_mime_object_set_header (GMIME_OBJECT (reply), ++ "In-Reply-To", in_reply_to); ++ ++ orig_references = notmuch_message_get_header (message, "references"); ++ references = talloc_asprintf (ctx, "%s%s%s", ++ orig_references ? orig_references : "", ++ orig_references ? " " : "", ++ in_reply_to); ++ g_mime_object_set_header (GMIME_OBJECT (reply), ++ "References", references); ++ ++ return reply; ++} ++ + static int + notmuch_reply_format_default(void *ctx, + notmuch_config_t *config, +@@ -515,8 +570,6 @@ notmuch_reply_format_default(void *ctx, + GMimeMessage *reply; + notmuch_messages_t *messages; + notmuch_message_t *message; +- const char *subject, *from_addr = NULL; +- const char *in_reply_to, *orig_references, *references; + const notmuch_show_format_t *format = &format_reply; + + for (messages = notmuch_query_search_messages (query); +@@ -525,48 +578,10 @@ notmuch_reply_format_default(void *ctx, + { + message = notmuch_messages_get (messages); + +- /* The 1 means we want headers in a "pretty" order. */ +- reply = g_mime_message_new (1); +- if (reply == NULL) { +- fprintf (stderr, "Out of memory\n"); +- return 1; +- } +- +- subject = notmuch_message_get_header (message, "subject"); +- if (subject) { +- if (strncasecmp (subject, "Re:", 3)) +- subject = talloc_asprintf (ctx, "Re: %s", subject); +- g_mime_message_set_subject (reply, subject); +- } +- +- from_addr = add_recipients_from_message (reply, config, message, +- reply_all); +- +- if (from_addr == NULL) +- from_addr = guess_from_received_header (config, message); +- +- if (from_addr == NULL) +- from_addr = notmuch_config_get_user_primary_email (config); ++ reply = create_reply_message (ctx, config, message, reply_all); + +- from_addr = talloc_asprintf (ctx, "%s <%s>", +- notmuch_config_get_user_name (config), +- from_addr); +- g_mime_object_set_header (GMIME_OBJECT (reply), +- "From", from_addr); +- +- in_reply_to = talloc_asprintf (ctx, "<%s>", +- notmuch_message_get_message_id (message)); +- +- g_mime_object_set_header (GMIME_OBJECT (reply), +- "In-Reply-To", in_reply_to); +- +- orig_references = notmuch_message_get_header (message, "references"); +- references = talloc_asprintf (ctx, "%s%s%s", +- orig_references ? orig_references : "", +- orig_references ? " " : "", +- in_reply_to); +- g_mime_object_set_header (GMIME_OBJECT (reply), +- "References", references); ++ if (!reply) ++ continue; + + show_reply_headers (reply); + +@@ -584,6 +599,89 @@ notmuch_reply_format_default(void *ctx, + return 0; + } + ++static void ++format_reply_headers_json (const void *ctx, GMimeMessage *message) ++{ ++ void *local = talloc_new (ctx); ++ InternetAddressList *recipients; ++ const char *recipients_string; ++ ++ printf ("{%s: %s", ++ json_quote_str (local, "Subject"), ++ json_quote_str (local, g_mime_message_get_subject (message))); ++ printf (", %s: %s", ++ json_quote_str (local, "From"), ++ json_quote_str (local, g_mime_message_get_sender (message))); ++ recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO); ++ recipients_string = internet_address_list_to_string (recipients, 0); ++ if (recipients_string) ++ printf (", %s: %s", ++ json_quote_str (local, "To"), ++ json_quote_str (local, recipients_string)); ++ recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC); ++ recipients_string = internet_address_list_to_string (recipients, 0); ++ if (recipients_string) ++ printf (", %s: %s", ++ json_quote_str (local, "Cc"), ++ json_quote_str (local, recipients_string)); ++ ++ 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"))); ++ ++ talloc_free (local); ++} ++ ++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_reply_headers_json (ctx, reply); ++ printf ("}"); ++ 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, +@@ -646,6 +744,7 @@ notmuch_reply_format_headers_only(void *ctx, + + enum { + FORMAT_DEFAULT, ++ FORMAT_JSON, + FORMAT_HEADERS_ONLY, + }; + +@@ -665,6 +764,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', +@@ -683,6 +783,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 6a171a4..c570a16 100644 +--- a/notmuch-show.c ++++ b/notmuch-show.c +@@ -652,7 +652,7 @@ format_part_text (const void *ctx, mime_node_t *node, + printf ("\f%s}\n", part_type); + } + +-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 +-- +1.7.5.4 + -- 2.26.2