Re: [PATCH] sprinters: bugfix when NULL passed for a string.
authorMark Walters <markwalters1009@gmail.com>
Wed, 8 Aug 2012 07:31:00 +0000 (08:31 +0100)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:48:58 +0000 (09:48 -0800)
be/2e62d51a6f09d22fe87b0054aea335562370ed [new file with mode: 0644]

diff --git a/be/2e62d51a6f09d22fe87b0054aea335562370ed b/be/2e62d51a6f09d22fe87b0054aea335562370ed
new file mode 100644 (file)
index 0000000..9d9210b
--- /dev/null
@@ -0,0 +1,198 @@
+Return-Path: <m.walters@qmul.ac.uk>\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 9539C431FAF\r
+       for <notmuch@notmuchmail.org>; Wed,  8 Aug 2012 00:31:17 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -1.098\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5\r
+       tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001,\r
+       NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] 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 66m1KglKLmZl for <notmuch@notmuchmail.org>;\r
+       Wed,  8 Aug 2012 00:31:13 -0700 (PDT)\r
+Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id AF15F431FAE\r
+       for <notmuch@notmuchmail.org>; Wed,  8 Aug 2012 00:31:13 -0700 (PDT)\r
+Received: from smtp.qmul.ac.uk ([138.37.6.40])\r
+       by mail2.qmul.ac.uk with esmtp (Exim 4.71)\r
+       (envelope-from <m.walters@qmul.ac.uk>)\r
+       id 1Sz0jS-0000ni-5Y; Wed, 08 Aug 2012 08:31:08 +0100\r
+Received: from 94-192-233-223.zone6.bethere.co.uk ([94.192.233.223]\r
+       helo=localhost)\r
+       by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.69)\r
+       (envelope-from <m.walters@qmul.ac.uk>)\r
+       id 1Sz0jR-00009p-Pt; Wed, 08 Aug 2012 08:31:06 +0100\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: Austin Clements <amdragon@MIT.EDU>, Ben Gamari <bgamari.foss@gmail.com>,\r
+       notmuch@notmuchmail.org\r
+Subject: Re: [PATCH] sprinters: bugfix when NULL passed for a string.\r
+In-Reply-To: <87ipcut9r4.fsf@awakening.csail.mit.edu>\r
+References: <871ujjuu2z.fsf@gmail.com> <878vdrp4d9.fsf@qmul.ac.uk>\r
+       <874noe1o0r.fsf@qmul.ac.uk>\r
+       <87ipcut9r4.fsf@awakening.csail.mit.edu>\r
+User-Agent: Notmuch/0.13.2+96~g634443c (http://notmuchmail.org) Emacs/23.4.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Wed, 08 Aug 2012 08:31:00 +0100\r
+Message-ID: <878vdp3knf.fsf@qmul.ac.uk>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Sender-Host-Address: 94.192.233.223\r
+X-QM-SPAM-Info: Sender has good ham record.  :)\r
+X-QM-Body-MD5: 84b053bed1825c7735338e4e4331007e (of first 20000 bytes)\r
+X-SpamAssassin-Score: -1.8\r
+X-SpamAssassin-SpamBar: -\r
+X-SpamAssassin-Report: The QM spam filters have analysed this message to\r
+       determine if it is\r
+       spam. We require at least 5.0 points to mark a message as spam.\r
+       This message scored -1.8 points.\r
+       Summary of the scoring: \r
+       * -2.3 RCVD_IN_DNSWL_MED RBL: Sender listed at http://www.dnswl.org/,\r
+       *      medium trust\r
+       *      [138.37.6.40 listed in list.dnswl.org]\r
+       * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail\r
+       provider *      (markwalters1009[at]gmail.com)\r
+       * -0.0 T_RP_MATCHES_RCVD Envelope sender domain matches handover relay\r
+       *      domain\r
+       *  0.5 AWL AWL: From: address is in the auto white-list\r
+X-QM-Scan-Virus: ClamAV says the message is clean\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: Wed, 08 Aug 2012 07:31:17 -0000\r
+\r
+\r
+On Wed, 08 Aug 2012, Austin Clements <amdragon@MIT.EDU> wrote:\r
+> LGTM.\r
+>\r
+> This won't commute with [0], since that introduces broken tests that are\r
+> fixed by this patch.\r
+\r
+Yes: I guess the tidiest might be for me to send a version of my patch\r
+which marks these tests fixed so it can be applied after this.\r
+\r
+> I think we should remove the fields in the JSON header object for\r
+> missing headers (except perhaps From and Date, if those really are\r
+> mandatory headers), but I think we should do that after the freeze,\r
+> since it might affect frontends.  \r
+\r
+I agree with you and Jamie on this. I think it is a `feature' rather\r
+than a bugfix (the current patch just restores the output to what it was\r
+before the sprinter changes it) so agree it should be after the\r
+freeze. We could deprecate passing NULL to sprinter string functions\r
+(possibly keep the check but fprintf a warning?)\r
+\r
+For the From/Date headers see http://www.ietf.org/rfc/rfc2822.txt\r
+section 3.6 for details:\r
+\r
+   The only required header fields are the origination date field and\r
+   the originator address field(s).  All other header fields are\r
+   syntactically optional.\r
+\r
+and origination date field means a Date: header, and originator\r
+address field means a From: header. However, I don't think an empty\r
+string is valid for either of these so we can't sensibly output\r
+something standards compliant. Thus I would go for following the\r
+original message and omit any fields not present in it.\r
+\r
+> It probably makes sense to add an Emacs test or two to the tests in [0].\r
+\r
+This seems like a good idea.\r
+\r
+Best wishes\r
+\r
+Mark\r
+\r
+\r
+> [0] id:"1344389313-7886-1-git-send-email-amdragon@mit.edu"\r
+>\r
+> On Tue, 07 Aug 2012, Mark Walters <markwalters1009@gmail.com> wrote:\r
+>> The string function in a sprinter may be called with a NULL string\r
+>> pointer (eg if a header is absent). This causes a segfault. We fix\r
+>> this by checking for a null pointer in the string functions and update\r
+>> the sprinter documentation.\r
+>>\r
+>> At the moment some output when format=text is done directly rather than\r
+>> via an sprinter: in that case a null pointer is passed to printf or\r
+>> similar and a "(null)" appears in the output. That behaviour is not\r
+>> changed in this patch.\r
+>> ---\r
+>>\r
+>> This could really do with some tests (it is the second time this type of\r
+>> bug has occurred). To be considered as a message by notmuch new a file\r
+>> needs at least one of a From: Subject: or To: header. Thus we should\r
+>> have three messages each of which just contains that single header (and\r
+>> nothing else) and check that search and show work as expected. \r
+>>\r
+>>\r
+>>\r
+>>  sprinter-json.c |    2 ++\r
+>>  sprinter-text.c |    2 ++\r
+>>  sprinter.h      |    4 +++-\r
+>>  3 files changed, 7 insertions(+), 1 deletions(-)\r
+>>\r
+>> diff --git a/sprinter-json.c b/sprinter-json.c\r
+>> index c9b6835..0a07790 100644\r
+>> --- a/sprinter-json.c\r
+>> +++ b/sprinter-json.c\r
+>> @@ -118,6 +118,8 @@ json_string_len (struct sprinter *sp, const char *val, size_t len)\r
+>>  static void\r
+>>  json_string (struct sprinter *sp, const char *val)\r
+>>  {\r
+>> +    if (val == NULL)\r
+>> +   val = "";\r
+>>      json_string_len (sp, val, strlen (val));\r
+>>  }\r
+>>  \r
+>> diff --git a/sprinter-text.c b/sprinter-text.c\r
+>> index dfa54b5..10343be 100644\r
+>> --- a/sprinter-text.c\r
+>> +++ b/sprinter-text.c\r
+>> @@ -38,6 +38,8 @@ text_string_len (struct sprinter *sp, const char *val, size_t len)\r
+>>  static void\r
+>>  text_string (struct sprinter *sp, const char *val)\r
+>>  {\r
+>> +    if (val == NULL)\r
+>> +   val = "";\r
+>>      text_string_len (sp, val, strlen (val));\r
+>>  }\r
+>>  \r
+>> diff --git a/sprinter.h b/sprinter.h\r
+>> index 5f43175..912a526 100644\r
+>> --- a/sprinter.h\r
+>> +++ b/sprinter.h\r
+>> @@ -27,7 +27,9 @@ typedef struct sprinter {\r
+>>       * a list or map, followed or preceded by separators).  For string\r
+>>       * and string_len, the char * must be UTF-8 encoded.  string_len\r
+>>       * allows non-terminated strings and strings with embedded NULs\r
+>> -     * (though the handling of the latter is format-dependent).\r
+>> +     * (though the handling of the latter is format-dependent). For\r
+>> +     * string (but not string_len) the string pointer passed may be\r
+>> +     * NULL.\r
+>>       */\r
+>>      void (*string) (struct sprinter *, const char *);\r
+>>      void (*string_len) (struct sprinter *, const char *, size_t);\r
+>> -- \r
+>> 1.7.9.1\r
+>>\r
+>>\r
+>> H\r
+>> _______________________________________________\r
+>> notmuch mailing list\r
+>> notmuch@notmuchmail.org\r
+>> http://notmuchmail.org/mailman/listinfo/notmuch\r