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