[PATCH v4 2/4] reply: Add a JSON reply format.
authorAdam Wolfe Gordon <awg+notmuch@xvx.ca>
Thu, 9 Feb 2012 00:21:54 +0000 (17:21 +1700)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:44:18 +0000 (09:44 -0800)
c1/b1f9702b4e4282d3d33ab9571c41faf39d8f3f [new file with mode: 0644]

diff --git a/c1/b1f9702b4e4282d3d33ab9571c41faf39d8f3f b/c1/b1f9702b4e4282d3d33ab9571c41faf39d8f3f
new file mode 100644 (file)
index 0000000..eb3e367
--- /dev/null
@@ -0,0 +1,339 @@
+Return-Path: <awg@lagos.xvx.ca>\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 3B62E429E3B\r
+       for <notmuch@notmuchmail.org>; Wed,  8 Feb 2012 16:22:12 -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\r
+       tests=[RCVD_IN_DNSWL_NONE=-0.0001] 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 Q9blpNBKc6Ka for <notmuch@notmuchmail.org>;\r
+       Wed,  8 Feb 2012 16:22:09 -0800 (PST)\r
+Received: from idcmail-mo1so.shaw.ca (idcmail-mo1so.shaw.ca [24.71.223.10])\r
+       by olra.theworths.org (Postfix) with ESMTP id E87A5429E25\r
+       for <notmuch@notmuchmail.org>; Wed,  8 Feb 2012 16:22:08 -0800 (PST)\r
+Received: from pd2ml2so-ssvc.prod.shaw.ca ([10.0.141.134])\r
+       by pd3mo1so-svcs.prod.shaw.ca with ESMTP; 08 Feb 2012 17:22:07 -0700\r
+X-Cloudmark-SP-Filtered: true\r
+X-Cloudmark-SP-Result: v=1.1 cv=FBhiVrZmCxhz+jlnxOWeJaR14+PwdUeacMZGNnSzbtQ=\r
+       c=1 sm=1\r
+       a=55xAQ_mktAEA:10 a=BLceEmwcHowA:10 a=yQp6g8lIsgqumF79BAsFDg==:17\r
+       a=3-z4jJ9MB81Z5CkkUWIA:9 a=6eKa8LJ50ZS4bQRKnmUA:7\r
+       a=HpAAvcLHHh0Zw7uRqdWCyQ==:117\r
+Received: from unknown (HELO lagos.xvx.ca) ([96.52.216.56])\r
+       by pd2ml2so-dmz.prod.shaw.ca with ESMTP; 08 Feb 2012 17:22:07 -0700\r
+Received: by lagos.xvx.ca (Postfix, from userid 1000)\r
+       id 8D344802A3D9; Wed,  8 Feb 2012 17:22:07 -0700 (MST)\r
+From: Adam Wolfe Gordon <awg+notmuch@xvx.ca>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v4 2/4] reply: Add a JSON reply format.\r
+Date: Wed,  8 Feb 2012 17:21:54 -0700\r
+Message-Id: <1328746916-25447-3-git-send-email-awg+notmuch@xvx.ca>\r
+X-Mailer: git-send-email 1.7.5.4\r
+In-Reply-To: <1328746916-25447-1-git-send-email-awg+notmuch@xvx.ca>\r
+References: <1326995217-27423-1-git-send-email-awg+notmuch@xvx.ca>\r
+       <1328746916-25447-1-git-send-email-awg+notmuch@xvx.ca>\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: Thu, 09 Feb 2012 00:22:12 -0000\r
+\r
+This new JSON format for replies includes headers generated for a\r
+reply message as well as the headers of the original message.  Using\r
+this data, a client can intelligently create a reply. For example, the\r
+emacs client will be able to create replies with quoted HTML parts by\r
+parsing the HTML parts using w3m.\r
+\r
+Reply now enforces that only one message is returned, as the semantics\r
+of replying to multiple messages are not wel-defined.\r
+\r
+Show is modified such that --format=json no longer implies\r
+--entire-thread, as MUAs will use --format=json when constructing\r
+replies. The man page is updated to reflect this change.\r
+---\r
+ emacs/notmuch-query.el  |    2 +-\r
+ man/man1/notmuch-show.1 |    6 +--\r
+ notmuch-reply.c         |  167 +++++++++++++++++++++++++++++++++++------------\r
+ notmuch-show.c          |    1 -\r
+ 4 files changed, 126 insertions(+), 50 deletions(-)\r
+\r
+diff --git a/emacs/notmuch-query.el b/emacs/notmuch-query.el\r
+index d66baea..cdf2d6b 100644\r
+--- a/emacs/notmuch-query.el\r
++++ b/emacs/notmuch-query.el\r
+@@ -29,7 +29,7 @@ A thread is a forest or list of trees. A tree is a two element\r
+ list where the first element is a message, and the second element\r
+ is a possibly empty forest of replies.\r
+ "\r
+-  (let  ((args '("show" "--format=json"))\r
++  (let  ((args '("show" "--format=json" "--entire-thread"))\r
+        (json-object-type 'plist)\r
+        (json-array-type 'list)\r
+        (json-false 'nil))\r
+diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1\r
+index b2301d8..c86b9db 100644\r
+--- a/man/man1/notmuch-show.1\r
++++ b/man/man1/notmuch-show.1\r
+@@ -55,11 +55,7 @@ be nested.\r
+ The output is formatted with Javascript Object Notation (JSON). This\r
+ format is more robust than the text format for automated\r
+ processing. The nested structure of multipart MIME messages is\r
+-reflected in nested JSON output. JSON output always includes all\r
+-messages in a matching thread; in effect\r
+-.B \-\-format=json\r
+-implies\r
+-.B \-\-entire\-thread\r
++reflected in nested JSON output.\r
+ \r
+ .RE\r
+ .RS 4\r
+diff --git a/notmuch-reply.c b/notmuch-reply.c\r
+index f55b1d2..bfbc307 100644\r
+--- a/notmuch-reply.c\r
++++ b/notmuch-reply.c\r
+@@ -505,6 +505,61 @@ guess_from_received_header (notmuch_config_t *config, notmuch_message_t *message\r
+     return NULL;\r
+ }\r
+ \r
++static GMimeMessage *\r
++create_reply_message(void *ctx,\r
++                   notmuch_config_t *config,\r
++                   notmuch_message_t *message,\r
++                   notmuch_bool_t reply_all)\r
++{\r
++    const char *subject, *from_addr = NULL;\r
++    const char *in_reply_to, *orig_references, *references;\r
++\r
++    /* The 1 means we want headers in a "pretty" order. */\r
++    GMimeMessage *reply = g_mime_message_new (1);\r
++    if (reply == NULL) {\r
++      fprintf (stderr, "Out of memory\n");\r
++      return NULL;\r
++    }\r
++\r
++    subject = notmuch_message_get_header (message, "subject");\r
++    if (subject) {\r
++      if (strncasecmp (subject, "Re:", 3))\r
++          subject = talloc_asprintf (ctx, "Re: %s", subject);\r
++      g_mime_message_set_subject (reply, subject);\r
++    }\r
++\r
++    from_addr = add_recipients_from_message (reply, config,\r
++                                           message, reply_all);\r
++\r
++    if (from_addr == NULL)\r
++      from_addr = guess_from_received_header (config, message);\r
++\r
++    if (from_addr == NULL)\r
++      from_addr = notmuch_config_get_user_primary_email (config);\r
++\r
++    from_addr = talloc_asprintf (ctx, "%s <%s>",\r
++                               notmuch_config_get_user_name (config),\r
++                               from_addr);\r
++    g_mime_object_set_header (GMIME_OBJECT (reply),\r
++                            "From", from_addr);\r
++\r
++    in_reply_to = talloc_asprintf (ctx, "<%s>",\r
++                                 notmuch_message_get_message_id (message));\r
++\r
++    g_mime_object_set_header (GMIME_OBJECT (reply),\r
++                            "In-Reply-To", in_reply_to);\r
++\r
++    orig_references = notmuch_message_get_header (message, "references");\r
++    references = talloc_asprintf (ctx, "%s%s%s",\r
++                                orig_references ? orig_references : "",\r
++                                orig_references ? " " : "",\r
++                                in_reply_to);\r
++    g_mime_object_set_header (GMIME_OBJECT (reply),\r
++                            "References", references);\r
++\r
++    return reply;\r
++}\r
++\r
+ static int\r
+ notmuch_reply_format_default(void *ctx,\r
+                            notmuch_config_t *config,\r
+@@ -515,8 +570,6 @@ notmuch_reply_format_default(void *ctx,\r
+     GMimeMessage *reply;\r
+     notmuch_messages_t *messages;\r
+     notmuch_message_t *message;\r
+-    const char *subject, *from_addr = NULL;\r
+-    const char *in_reply_to, *orig_references, *references;\r
+     const notmuch_show_format_t *format = &format_reply;\r
+ \r
+     for (messages = notmuch_query_search_messages (query);\r
+@@ -525,48 +578,10 @@ notmuch_reply_format_default(void *ctx,\r
+     {\r
+       message = notmuch_messages_get (messages);\r
+ \r
+-      /* The 1 means we want headers in a "pretty" order. */\r
+-      reply = g_mime_message_new (1);\r
+-      if (reply == NULL) {\r
+-          fprintf (stderr, "Out of memory\n");\r
+-          return 1;\r
+-      }\r
+-\r
+-      subject = notmuch_message_get_header (message, "subject");\r
+-      if (subject) {\r
+-          if (strncasecmp (subject, "Re:", 3))\r
+-              subject = talloc_asprintf (ctx, "Re: %s", subject);\r
+-          g_mime_message_set_subject (reply, subject);\r
+-      }\r
+-\r
+-      from_addr = add_recipients_from_message (reply, config, message,\r
+-                                               reply_all);\r
+-\r
+-      if (from_addr == NULL)\r
+-          from_addr = guess_from_received_header (config, message);\r
++      reply = create_reply_message (ctx, config, message, reply_all);\r
+ \r
+-      if (from_addr == NULL)\r
+-          from_addr = notmuch_config_get_user_primary_email (config);\r
+-\r
+-      from_addr = talloc_asprintf (ctx, "%s <%s>",\r
+-                                   notmuch_config_get_user_name (config),\r
+-                                   from_addr);\r
+-      g_mime_object_set_header (GMIME_OBJECT (reply),\r
+-                                "From", from_addr);\r
+-\r
+-      in_reply_to = talloc_asprintf (ctx, "<%s>",\r
+-                           notmuch_message_get_message_id (message));\r
+-\r
+-      g_mime_object_set_header (GMIME_OBJECT (reply),\r
+-                                "In-Reply-To", in_reply_to);\r
+-\r
+-      orig_references = notmuch_message_get_header (message, "references");\r
+-      references = talloc_asprintf (ctx, "%s%s%s",\r
+-                                    orig_references ? orig_references : "",\r
+-                                    orig_references ? " " : "",\r
+-                                    in_reply_to);\r
+-      g_mime_object_set_header (GMIME_OBJECT (reply),\r
+-                                "References", references);\r
++      if (!reply)\r
++          continue;\r
+ \r
+       show_reply_headers (reply);\r
+ \r
+@@ -584,6 +599,68 @@ notmuch_reply_format_default(void *ctx,\r
+     return 0;\r
+ }\r
+ \r
++static int\r
++notmuch_reply_format_json(void *ctx,\r
++                        notmuch_config_t *config,\r
++                        notmuch_query_t *query,\r
++                        unused (notmuch_show_params_t *params),\r
++                        notmuch_bool_t reply_all)\r
++{\r
++    GMimeMessage *reply;\r
++    notmuch_messages_t *messages;\r
++    notmuch_message_t *message;\r
++\r
++    const char *reply_headers[] = {"from", "to", "subject", "in-reply-to", "references"};\r
++    const char *orig_headers[] = {"from", "to", "cc", "subject", "date", "in-reply-to", "references", "message-id"};\r
++    unsigned int hidx;\r
++\r
++    if (notmuch_query_count_messages (query) != 1) {\r
++      fprintf (stderr, "Error: search term did not match precisely one message.\n");\r
++      return 1;\r
++    }\r
++\r
++    messages = notmuch_query_search_messages (query);\r
++    message = notmuch_messages_get (messages);\r
++\r
++    reply = create_reply_message (ctx, config, message, reply_all);\r
++    if (!reply)\r
++      return 1;\r
++\r
++    /* Start a reply object */\r
++    printf ("{ \"reply\": { ");\r
++\r
++    for (hidx = 0; hidx < ARRAY_SIZE (reply_headers); hidx++) {\r
++      if (hidx)\r
++          printf (", ");\r
++\r
++      printf ("%s: %s", json_quote_str (ctx, reply_headers[hidx]),\r
++              json_quote_str (ctx, g_mime_object_get_header (GMIME_OBJECT (reply), reply_headers[hidx])));\r
++    }\r
++\r
++    g_object_unref (G_OBJECT (reply));\r
++    reply = NULL;\r
++\r
++    /* Done the headers for the reply, which has no body */\r
++    printf (" }");\r
++\r
++    /* Start the original */\r
++    printf (", \"original\": { ");\r
++\r
++    for (hidx = 0; hidx < ARRAY_SIZE (orig_headers); hidx++) {\r
++      if (hidx)\r
++          printf (", ");\r
++\r
++      printf ("%s: %s", json_quote_str (ctx, orig_headers[hidx]),\r
++              json_quote_str (ctx, notmuch_message_get_header (message, orig_headers[hidx])));\r
++    }\r
++\r
++    /* End */\r
++    printf (" } }\n");\r
++    notmuch_message_destroy (message);\r
++\r
++    return 0;\r
++}\r
++\r
+ /* This format is currently tuned for a git send-email --notmuch hook */\r
+ static int\r
+ notmuch_reply_format_headers_only(void *ctx,\r
+@@ -646,6 +723,7 @@ notmuch_reply_format_headers_only(void *ctx,\r
+ \r
+ enum {\r
+     FORMAT_DEFAULT,\r
++    FORMAT_JSON,\r
+     FORMAT_HEADERS_ONLY,\r
+ };\r
+ \r
+@@ -666,6 +744,7 @@ notmuch_reply_command (void *ctx, int argc, char *argv[])\r
+     notmuch_opt_desc_t options[] = {\r
+       { NOTMUCH_OPT_KEYWORD, &format, "format", 'f',\r
+         (notmuch_keyword_t []){ { "default", FORMAT_DEFAULT },\r
++                                { "json", FORMAT_JSON },\r
+                                 { "headers-only", FORMAT_HEADERS_ONLY },\r
+                                 { 0, 0 } } },\r
+       { NOTMUCH_OPT_KEYWORD, &reply_all, "reply-to", 'r',\r
+@@ -684,6 +763,8 @@ notmuch_reply_command (void *ctx, int argc, char *argv[])\r
+ \r
+     if (format == FORMAT_HEADERS_ONLY)\r
+       reply_format_func = notmuch_reply_format_headers_only;\r
++    else if (format == FORMAT_JSON)\r
++      reply_format_func = notmuch_reply_format_json;\r
+     else\r
+       reply_format_func = notmuch_reply_format_default;\r
+ \r
+diff --git a/notmuch-show.c b/notmuch-show.c\r
+index dec799c..344d08c 100644\r
+--- a/notmuch-show.c\r
++++ b/notmuch-show.c\r
+@@ -1082,7 +1082,6 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+               format = &format_text;\r
+           } else if (strcmp (opt, "json") == 0) {\r
+               format = &format_json;\r
+-              params.entire_thread = 1;\r
+           } else if (strcmp (opt, "mbox") == 0) {\r
+               format = &format_mbox;\r
+               mbox = 1;\r
+-- \r
+1.7.5.4\r
+\r