[PATCH v3 2/5] reply: Add a JSON reply format.
authorAdam Wolfe Gordon <awg+notmuch@xvx.ca>
Thu, 19 Jan 2012 17:46:54 +0000 (10:46 +1700)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:42:42 +0000 (09:42 -0800)
79/41db4147c2e49222e3ec87d643d48613024a4e [new file with mode: 0644]

diff --git a/79/41db4147c2e49222e3ec87d643d48613024a4e b/79/41db4147c2e49222e3ec87d643d48613024a4e
new file mode 100644 (file)
index 0000000..496bb84
--- /dev/null
@@ -0,0 +1,428 @@
+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 7A18E431FB6\r
+       for <notmuch@notmuchmail.org>; Thu, 19 Jan 2012 09:47:08 -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 QgH9W-AiTYPd for <notmuch@notmuchmail.org>;\r
+       Thu, 19 Jan 2012 09:47:06 -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 628C1431FAF\r
+       for <notmuch@notmuchmail.org>; Thu, 19 Jan 2012 09:47:06 -0800 (PST)\r
+Received: from pd2ml1so-ssvc.prod.shaw.ca ([10.0.141.139])\r
+       by pd3mo1so-svcs.prod.shaw.ca with ESMTP; 19 Jan 2012 10:47:05 -0700\r
+X-Cloudmark-SP-Filtered: true\r
+X-Cloudmark-SP-Result: v=1.1 cv=2TvZ7eE48NdEYeaL5Xf58dNzJU178UzT+2lxUZ5Mhss=\r
+       c=1 sm=1\r
+       a=KjgQ5C8P-WoA:10 a=BLceEmwcHowA:10 a=yQp6g8lIsgqumF79BAsFDg==:17\r
+       a=N75QUTFPbXuT58Tj8oQA:9 a=C19m0dVcnEdJqkZIeEwA:7\r
+       a=HpAAvcLHHh0Zw7uRqdWCyQ==:117\r
+Received: from unknown (HELO lagos.xvx.ca) ([96.52.216.56])\r
+       by pd2ml1so-dmz.prod.shaw.ca with ESMTP; 19 Jan 2012 10:47:05 -0700\r
+Received: by lagos.xvx.ca (Postfix, from userid 1000)\r
+       id 031818004C3C; Thu, 19 Jan 2012 10:47:04 -0700 (MST)\r
+From: Adam Wolfe Gordon <awg+notmuch@xvx.ca>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v3 2/5] reply: Add a JSON reply format.\r
+Date: Thu, 19 Jan 2012 10:46:54 -0700\r
+Message-Id: <1326995217-27423-3-git-send-email-awg+notmuch@xvx.ca>\r
+X-Mailer: git-send-email 1.7.5.4\r
+In-Reply-To: <1326995217-27423-1-git-send-email-awg+notmuch@xvx.ca>\r
+References: <1326995217-27423-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, 19 Jan 2012 17:47:09 -0000\r
+\r
+This new JSON format for replies includes headers generated for a reply\r
+message as well as the headers and all text parts of the original message.\r
+Using this data, a client can intelligently create a reply. For example,\r
+the emacs client will be able to create replies with quoted HTML parts by\r
+parsing the HTML parts using w3m.\r
+---\r
+ notmuch-reply.c |  271 +++++++++++++++++++++++++++++++++++++++++++++++--------\r
+ 1 files changed, 231 insertions(+), 40 deletions(-)\r
+\r
+diff --git a/notmuch-reply.c b/notmuch-reply.c\r
+index 0f682db..b4c2426 100644\r
+--- a/notmuch-reply.c\r
++++ b/notmuch-reply.c\r
+@@ -30,6 +30,15 @@ reply_headers_message_part (GMimeMessage *message);\r
+ static void\r
+ reply_part_content (GMimeObject *part);\r
\r
++static void\r
++reply_part_start_json (GMimeObject *part, int *part_count);\r
++\r
++static void\r
++reply_part_content_json (GMimeObject *part);\r
++\r
++static void\r
++reply_part_end_json (GMimeObject *part);\r
++\r
+ static const notmuch_show_format_t format_reply = {\r
+     "",\r
+       "", NULL,\r
+@@ -46,6 +55,22 @@ static const notmuch_show_format_t format_reply = {\r
+     ""\r
+ };\r
\r
++static const notmuch_show_format_t format_json = {\r
++    "",\r
++      "", NULL,\r
++          "", NULL, NULL, "",\r
++          "",\r
++              reply_part_start_json,\r
++              NULL,\r
++              NULL,\r
++              reply_part_content_json,\r
++              reply_part_end_json,\r
++              "",\r
++          "",\r
++      "", "",\r
++    ""\r
++};\r
++\r
+ static void\r
+ show_reply_headers (GMimeMessage *message)\r
+ {\r
+@@ -86,6 +111,17 @@ reply_headers_message_part (GMimeMessage *message)\r
+     printf ("> Date: %s\n", g_mime_message_get_date_as_string (message));\r
+ }\r
\r
++static notmuch_bool_t\r
++reply_check_part_type (GMimeObject *part, const char *type, const char *subtype,\r
++                     const char *disposition)\r
++{\r
++    GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));\r
++    GMimeContentDisposition *part_disposition = g_mime_object_get_content_disposition (part);\r
++\r
++    return (g_mime_content_type_is_type (content_type, type, subtype) &&\r
++          (!part_disposition ||\r
++           strcmp (part_disposition->disposition, disposition) == 0));\r
++}\r
\r
+ static void\r
+ reply_part_content (GMimeObject *part)\r
+@@ -147,6 +183,63 @@ reply_part_content (GMimeObject *part)\r
+     }\r
+ }\r
\r
++static void\r
++reply_part_start_json (GMimeObject *part, unused (int *part_count))\r
++{\r
++    if (reply_check_part_type (part, "text", "*", GMIME_DISPOSITION_INLINE))\r
++      printf ("{ ");\r
++}\r
++\r
++static void\r
++reply_part_end_json (GMimeObject *part)\r
++{\r
++    if (reply_check_part_type (part, "text", "*", GMIME_DISPOSITION_INLINE))\r
++      printf ("}, ");\r
++}\r
++\r
++static void\r
++reply_part_content_json (GMimeObject *part)\r
++{\r
++    GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));\r
++    void *ctx = talloc_new (NULL);\r
++\r
++    /* We only care about inline text parts for reply purposes */\r
++    if (reply_check_part_type (part, "text", "*", GMIME_DISPOSITION_INLINE)) {\r
++      GMimeDataWrapper *wrapper;\r
++      GByteArray *part_content;\r
++\r
++      printf ("\"content-type\": %s, \"content\": ",\r
++             json_quote_str (ctx, g_mime_content_type_to_string (content_type)));\r
++\r
++      wrapper = g_mime_part_get_content_object (GMIME_PART (part));\r
++      if (wrapper) {\r
++          const char *charset = g_mime_object_get_content_type_parameter (part, "charset");\r
++          GMimeStream *stream_memory = g_mime_stream_mem_new ();\r
++          if (stream_memory) {\r
++              GMimeStream *stream_filter = NULL;\r
++              stream_filter = g_mime_stream_filter_new (stream_memory);\r
++              if (charset) {\r
++                  g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),\r
++                                            g_mime_filter_charset_new (charset, "UTF-8"));\r
++              }\r
++\r
++              if (stream_filter) {\r
++                  g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);\r
++                  part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));\r
++\r
++                  printf ("%s", json_quote_chararray (ctx, (char *) part_content->data, part_content->len));\r
++                  g_object_unref (stream_filter);\r
++              }\r
++          }\r
++\r
++          if (stream_memory)\r
++              g_object_unref (stream_memory);\r
++      }\r
++    }\r
++\r
++    talloc_free (ctx);\r
++}\r
++\r
+ /* Is the given address configured as one of the user's "personal" or\r
+  * "other" addresses. */\r
+ static int\r
+@@ -505,6 +598,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 +663,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,62 +671,103 @@ 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
++      reply = create_reply_message (ctx, config, message, reply_all);\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
++      if (!reply)\r
++          continue;\r
\r
+-      from_addr = add_recipients_from_message (reply, config, message,\r
+-                                               reply_all);\r
++      show_reply_headers (reply);\r
\r
+-      if (from_addr == NULL)\r
+-          from_addr = guess_from_received_header (config, message);\r
++      g_object_unref (G_OBJECT (reply));\r
++      reply = NULL;\r
\r
+-      if (from_addr == NULL)\r
+-          from_addr = notmuch_config_get_user_primary_email (config);\r
++      printf ("On %s, %s wrote:\n",\r
++              notmuch_message_get_header (message, "date"),\r
++              notmuch_message_get_header (message, "from"));\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
++      show_message_body (message, format, params);\r
\r
+-      in_reply_to = talloc_asprintf (ctx, "<%s>",\r
+-                           notmuch_message_get_message_id (message));\r
++      notmuch_message_destroy (message);\r
++    }\r
++    return 0;\r
++}\r
\r
+-      g_mime_object_set_header (GMIME_OBJECT (reply),\r
+-                                "In-Reply-To", in_reply_to);\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
++    const notmuch_show_format_t *format = &format_json;\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
++    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"};\r
++    unsigned int hidx;\r
\r
+-      show_reply_headers (reply);\r
++    /* Start array of reply objects */\r
++    printf ("[");\r
++\r
++    for (messages = notmuch_query_search_messages (query);\r
++       notmuch_messages_valid (messages);\r
++       notmuch_messages_move_to_next (messages))\r
++    {\r
++      message = notmuch_messages_get (messages);\r
++      reply = create_reply_message (ctx, config, message, reply_all);\r
++      if (!reply)\r
++          continue;\r
++\r
++      /* Start a reply object */\r
++      printf ("{ \"reply\": { \"headers\": { ");\r
++\r
++      for (hidx = 0; hidx < ARRAY_SIZE (reply_headers); hidx++)\r
++      {\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
+-      printf ("On %s, %s wrote:\n",\r
+-              notmuch_message_get_header (message, "date"),\r
+-              notmuch_message_get_header (message, "from"));\r
++      /* Done the headers for the reply, which has no body parts */\r
++      printf ("} }");\r
++\r
++      /* Start the original */\r
++      printf (", \"original\": { \"headers\": { ");\r
++\r
++      for (hidx = 0; hidx < ARRAY_SIZE (orig_headers); hidx++)\r
++      {\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 headers */\r
++      printf (" }, \"body\": [ ");\r
\r
++      /* Show body parts */\r
+       show_message_body (message, format, params);\r
\r
+       notmuch_message_destroy (message);\r
++\r
++      /* Done the original */\r
++      printf ("{} ] }");\r
++\r
++      /* End the reply object. */\r
++      printf (" }, ");\r
+     }\r
++\r
++    /* End array of reply objects */\r
++    printf ("{} ]\n");\r
++\r
+     return 0;\r
+ }\r
\r
+@@ -646,6 +833,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 +854,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 +873,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
+-- \r
+1.7.5.4\r
+\r