notmuch-show: Add content-description output pair

Parse and display the Content-Description header [1,2] so UIs
rendering message parts have easy access to description strings.
Extracting the value is a two-step process (extract [3] and decode
[4]).

[1]: http://tools.ietf.org/html/rfc2045#section-8
[2]: http://tools.ietf.org/html/rfc2183#section-3
[3]: https://developer.gnome.org/gmime/stable/GMimeObject.html#g-mime-object-get-header
[4]: https://developer.gnome.org/gmime/stable/gmime-gmime-utils.html#g-mime-utils-header-decode-text

diff --git a/NEWS b/NEWS
index d4f4ea4e898887799d82eaf2fb412636b869bf00..f9e17615bcb97a650529debd11bddf329ac91eba 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -12,6 +12,9 @@ Command-Line Interface
 
   This option suppresses the progress and summary reports.
 
+`notmuch show` now includes envelope Content-Description headers if
+the header exists and has a non-empty value.
+
 Emacs Interface
 ---------------
 

diff --git a/devel/schemata b/devel/schemata
index 41dc4a60fff36608e25425c7f113c6f2a1b667b0..e655341b6c6b2cc0f2c49f8d1f87fd7a8ebf1723 100644 (file)
--- a/devel/schemata
+++ b/devel/schemata
@@ -84,6 +84,7 @@ part = {
     # otherwise (leaf parts):
     filename?:      string,
     content-charset?: string,
+    content-description?: string,
     # A leaf part's body content is optional, but may be included if
     # it can be correctly encoded as a string.  Consumers should use
     # this in preference to fetching the part content separately.

diff --git a/notmuch-show.c b/notmuch-show.c
index d416fbd5ccb73593ec44fd976bd331de0bf13be6..9d97bafb2908df8f1cd0be5152651a9c3ad6aa7a 100644 (file)
--- a/notmuch-show.c
+++ b/notmuch-show.c
@@ -659,6 +659,11 @@ format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
        GMIME_OBJECT (node->envelope_part) : node->part;
     GMimeContentType *content_type = g_mime_object_get_content_type (meta);
     const char *cid = g_mime_object_get_content_id (meta);
+    const char *encoded_description = g_mime_object_get_header (meta, "content-description");
+    const char *decoded_description = encoded_description ?
+       g_mime_utils_header_decode_text (encoded_description) : NULL;
+    const char *description = strlen (decoded_description) ?
+       decoded_description : NULL;
     const char *filename = GMIME_IS_PART (node->part) ?
        g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
     int nclose = 0;
@@ -692,6 +697,11 @@ format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
        sp->string (sp, cid);
     }
 
+    if (description) {
+       sp->map_key (sp, "content-description");
+       sp->string (sp, description);
+    }
+
     if (filename) {
        sp->map_key (sp, "filename");
        sp->string (sp, filename);

diff --git a/test/T160-json.sh b/test/T160-json.sh
index c1cf649d6dcad15735767911f414aa58361a4060..53f40efccf506c38d4b94be9f43ee1e0289b6aa6 100755 (executable)
--- a/test/T160-json.sh
+++ b/test/T160-json.sh
@@ -41,14 +41,14 @@ id="json-show-inline-attachment-filename@notmuchmail.org"
 emacs_fcc_message \
     "$subject" \
     'This is a test message with inline attachment with a filename' \
-    "(mml-attach-file \"$TEST_DIRECTORY/README\" nil nil \"inline\")
+    "(mml-attach-file \"$TEST_DIRECTORY/README\" nil \"Test README\" \"inline\")
      (message-goto-eoh)
      (insert \"Message-ID: <$id>\n\")"
 output=$(notmuch show --format=json "id:$id")
 filename=$(notmuch search --output=files "id:$id")
 # Get length of README after base64-encoding, minus additional newline.
 attachment_length=$(( $(base64 $TEST_DIRECTORY/README | wc -c) - 1 ))
-test_expect_equal_json "$output" "[[[{\"id\": \"$id\", \"match\": true, \"excluded\": false, \"filename\": \"$filename\", \"timestamp\": 946728000, \"date_relative\": \"2000-01-01\", \"tags\": [\"inbox\"], \"headers\": {\"Subject\": \"$subject\", \"From\": \"Notmuch Test Suite <test_suite@notmuchmail.org>\", \"To\": \"test_suite@notmuchmail.org\", \"Date\": \"Sat, 01 Jan 2000 12:00:00 +0000\"}, \"body\": [{\"id\": 1, \"content-type\": \"multipart/mixed\", \"content\": [{\"id\": 2, \"content-type\": \"text/plain\", \"content\": \"This is a test message with inline attachment with a filename\"}, {\"id\": 3, \"content-type\": \"application/octet-stream\", \"content-length\": $attachment_length, \"content-transfer-encoding\": \"base64\", \"filename\": \"README\"}]}]}, []]]]"
+test_expect_equal_json "$output" "[[[{\"id\": \"$id\", \"match\": true, \"excluded\": false, \"filename\": \"$filename\", \"timestamp\": 946728000, \"date_relative\": \"2000-01-01\", \"tags\": [\"inbox\"], \"headers\": {\"Subject\": \"$subject\", \"From\": \"Notmuch Test Suite <test_suite@notmuchmail.org>\", \"To\": \"test_suite@notmuchmail.org\", \"Date\": \"Sat, 01 Jan 2000 12:00:00 +0000\"}, \"body\": [{\"id\": 1, \"content-type\": \"multipart/mixed\", \"content\": [{\"id\": 2, \"content-type\": \"text/plain\", \"content\": \"This is a test message with inline attachment with a filename\"}, {\"id\": 3, \"content-type\": \"application/octet-stream\", \"content-description\": \"Test README\", \"content-length\": $attachment_length, \"content-transfer-encoding\": \"base64\", \"filename\": \"README\"}]}]}, []]]]"
 
 test_begin_subtest "Search message: json, utf-8"
 add_message "[subject]=\"json-search-utf8-body-sübjéct\"" "[date]=\"Sat, 01 Jan 2000 12:00:00 -0000\"" "[body]=\"jsön-search-méssage\""

diff --git a/test/T170-sexp.sh b/test/T170-sexp.sh
index 667e3195d836906c2d27498ade17a1f6fa7b0611..1c087d67f42ea1fc91f7324e982fe1fcdb4f21bd 100755 (executable)
--- a/test/T170-sexp.sh
+++ b/test/T170-sexp.sh
@@ -32,14 +32,14 @@ id="sexp-show-inline-attachment-filename@notmuchmail.org"
 emacs_fcc_message \
     "$subject" \
     'This is a test message with inline attachment with a filename' \
-    "(mml-attach-file \"$TEST_DIRECTORY/README\" nil nil \"inline\")
+    "(mml-attach-file \"$TEST_DIRECTORY/README\" nil \"Test README\" \"inline\")
      (message-goto-eoh)
      (insert \"Message-ID: <$id>\n\")"
 output=$(notmuch show --format=sexp "id:$id")
 filename=$(notmuch search --output=files "id:$id")
 # Get length of README after base64-encoding, minus additional newline.
 attachment_length=$(( $(base64 $TEST_DIRECTORY/README | wc -c) - 1 ))
-test_expect_equal "$output" "((((:id \"$id\" :match t :excluded nil :filename \"$filename\" :timestamp 946728000 :date_relative \"2000-01-01\" :tags (\"inbox\") :headers (:Subject \"sexp-show-inline-attachment-filename\" :From \"Notmuch Test Suite <test_suite@notmuchmail.org>\" :To \"test_suite@notmuchmail.org\" :Date \"Sat, 01 Jan 2000 12:00:00 +0000\") :body ((:id 1 :content-type \"multipart/mixed\" :content ((:id 2 :content-type \"text/plain\" :content \"This is a test message with inline attachment with a filename\") (:id 3 :content-type \"application/octet-stream\" :filename \"README\" :content-transfer-encoding \"base64\" :content-length $attachment_length))))) ())))"
+test_expect_equal "$output" "((((:id \"$id\" :match t :excluded nil :filename \"$filename\" :timestamp 946728000 :date_relative \"2000-01-01\" :tags (\"inbox\") :headers (:Subject \"sexp-show-inline-attachment-filename\" :From \"Notmuch Test Suite <test_suite@notmuchmail.org>\" :To \"test_suite@notmuchmail.org\" :Date \"Sat, 01 Jan 2000 12:00:00 +0000\") :body ((:id 1 :content-type \"multipart/mixed\" :content ((:id 2 :content-type \"text/plain\" :content \"This is a test message with inline attachment with a filename\") (:id 3 :content-type \"application/octet-stream\" :content-description \"Test README\" :filename \"README\" :content-transfer-encoding \"base64\" :content-length $attachment_length))))) ())))"
 
 test_begin_subtest "Search message: sexp, utf-8"
 add_message "[subject]=\"sexp-search-utf8-body-sübjéct\"" "[date]=\"Sat, 01 Jan 2000 12:00:00 -0000\"" "[body]=\"jsön-search-méssage\""