From: Adam Wolfe Gordon Date: Thu, 9 Feb 2012 00:21:54 +0000 (+1700) Subject: [PATCH v4 2/4] reply: Add a JSON reply format. X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=8a8deea01bc370288d590dd59d0d2bc292bbf57c;p=notmuch-archives.git [PATCH v4 2/4] reply: Add a JSON reply format. --- diff --git a/c1/b1f9702b4e4282d3d33ab9571c41faf39d8f3f b/c1/b1f9702b4e4282d3d33ab9571c41faf39d8f3f new file mode 100644 index 000000000..eb3e3677e --- /dev/null +++ b/c1/b1f9702b4e4282d3d33ab9571c41faf39d8f3f @@ -0,0 +1,339 @@ +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 3B62E429E3B + for ; Wed, 8 Feb 2012 16:22:12 -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 Q9blpNBKc6Ka for ; + Wed, 8 Feb 2012 16:22:09 -0800 (PST) +Received: from idcmail-mo1so.shaw.ca (idcmail-mo1so.shaw.ca [24.71.223.10]) + by olra.theworths.org (Postfix) with ESMTP id E87A5429E25 + for ; Wed, 8 Feb 2012 16:22:08 -0800 (PST) +Received: from pd2ml2so-ssvc.prod.shaw.ca ([10.0.141.134]) + by pd3mo1so-svcs.prod.shaw.ca with ESMTP; 08 Feb 2012 17:22:07 -0700 +X-Cloudmark-SP-Filtered: true +X-Cloudmark-SP-Result: v=1.1 cv=FBhiVrZmCxhz+jlnxOWeJaR14+PwdUeacMZGNnSzbtQ= + c=1 sm=1 + a=55xAQ_mktAEA:10 a=BLceEmwcHowA:10 a=yQp6g8lIsgqumF79BAsFDg==:17 + a=3-z4jJ9MB81Z5CkkUWIA:9 a=6eKa8LJ50ZS4bQRKnmUA:7 + a=HpAAvcLHHh0Zw7uRqdWCyQ==:117 +Received: from unknown (HELO lagos.xvx.ca) ([96.52.216.56]) + by pd2ml2so-dmz.prod.shaw.ca with ESMTP; 08 Feb 2012 17:22:07 -0700 +Received: by lagos.xvx.ca (Postfix, from userid 1000) + id 8D344802A3D9; Wed, 8 Feb 2012 17:22:07 -0700 (MST) +From: Adam Wolfe Gordon +To: notmuch@notmuchmail.org +Subject: [PATCH v4 2/4] reply: Add a JSON reply format. +Date: Wed, 8 Feb 2012 17:21:54 -0700 +Message-Id: <1328746916-25447-3-git-send-email-awg+notmuch@xvx.ca> +X-Mailer: git-send-email 1.7.5.4 +In-Reply-To: <1328746916-25447-1-git-send-email-awg+notmuch@xvx.ca> +References: <1326995217-27423-1-git-send-email-awg+notmuch@xvx.ca> + <1328746916-25447-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: Thu, 09 Feb 2012 00:22:12 -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 using w3m. + +Reply now enforces that only one message is returned, as the semantics +of replying to multiple messages are not wel-defined. + +Show is modified such that --format=json no longer implies +--entire-thread, as MUAs will use --format=json when constructing +replies. The man page is updated to reflect this change. +--- + emacs/notmuch-query.el | 2 +- + man/man1/notmuch-show.1 | 6 +-- + notmuch-reply.c | 167 +++++++++++++++++++++++++++++++++++------------ + notmuch-show.c | 1 - + 4 files changed, 126 insertions(+), 50 deletions(-) + +diff --git a/emacs/notmuch-query.el b/emacs/notmuch-query.el +index d66baea..cdf2d6b 100644 +--- a/emacs/notmuch-query.el ++++ b/emacs/notmuch-query.el +@@ -29,7 +29,7 @@ A thread is a forest or list of trees. A tree is a two element + list where the first element is a message, and the second element + is a possibly empty forest of replies. + " +- (let ((args '("show" "--format=json")) ++ (let ((args '("show" "--format=json" "--entire-thread")) + (json-object-type 'plist) + (json-array-type 'list) + (json-false 'nil)) +diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1 +index b2301d8..c86b9db 100644 +--- a/man/man1/notmuch-show.1 ++++ b/man/man1/notmuch-show.1 +@@ -55,11 +55,7 @@ be nested. + The output is formatted with Javascript Object Notation (JSON). This + format is more robust than the text format for automated + processing. The nested structure of multipart MIME messages is +-reflected in nested JSON output. JSON output always includes all +-messages in a matching thread; in effect +-.B \-\-format=json +-implies +-.B \-\-entire\-thread ++reflected in nested JSON output. + + .RE + .RS 4 +diff --git a/notmuch-reply.c b/notmuch-reply.c +index f55b1d2..bfbc307 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); ++ reply = create_reply_message (ctx, config, message, reply_all); + +- 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); ++ if (!reply) ++ continue; + + show_reply_headers (reply); + +@@ -584,6 +599,68 @@ notmuch_reply_format_default(void *ctx, + return 0; + } + ++static int ++notmuch_reply_format_json(void *ctx, ++ notmuch_config_t *config, ++ notmuch_query_t *query, ++ unused (notmuch_show_params_t *params), ++ notmuch_bool_t reply_all) ++{ ++ GMimeMessage *reply; ++ notmuch_messages_t *messages; ++ notmuch_message_t *message; ++ ++ const char *reply_headers[] = {"from", "to", "subject", "in-reply-to", "references"}; ++ const char *orig_headers[] = {"from", "to", "cc", "subject", "date", "in-reply-to", "references", "message-id"}; ++ unsigned int hidx; ++ ++ 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); ++ ++ reply = create_reply_message (ctx, config, message, reply_all); ++ if (!reply) ++ return 1; ++ ++ /* Start a reply object */ ++ printf ("{ \"reply\": { "); ++ ++ for (hidx = 0; hidx < ARRAY_SIZE (reply_headers); hidx++) { ++ if (hidx) ++ printf (", "); ++ ++ printf ("%s: %s", json_quote_str (ctx, reply_headers[hidx]), ++ json_quote_str (ctx, g_mime_object_get_header (GMIME_OBJECT (reply), reply_headers[hidx]))); ++ } ++ ++ g_object_unref (G_OBJECT (reply)); ++ reply = NULL; ++ ++ /* Done the headers for the reply, which has no body */ ++ printf (" }"); ++ ++ /* Start the original */ ++ printf (", \"original\": { "); ++ ++ for (hidx = 0; hidx < ARRAY_SIZE (orig_headers); hidx++) { ++ if (hidx) ++ printf (", "); ++ ++ printf ("%s: %s", json_quote_str (ctx, orig_headers[hidx]), ++ json_quote_str (ctx, notmuch_message_get_header (message, orig_headers[hidx]))); ++ } ++ ++ /* 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 +723,7 @@ notmuch_reply_format_headers_only(void *ctx, + + enum { + FORMAT_DEFAULT, ++ FORMAT_JSON, + FORMAT_HEADERS_ONLY, + }; + +@@ -666,6 +744,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', +@@ -684,6 +763,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 dec799c..344d08c 100644 +--- a/notmuch-show.c ++++ b/notmuch-show.c +@@ -1082,7 +1082,6 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) + format = &format_text; + } else if (strcmp (opt, "json") == 0) { + format = &format_json; +- params.entire_thread = 1; + } else if (strcmp (opt, "mbox") == 0) { + format = &format_mbox; + mbox = 1; +-- +1.7.5.4 +