DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma;
	h=mime-version:sender:in-reply-to:references:date
	:x-google-sender-auth:message-id:subject:from:to:cc:content-type
	:content-transfer-encoding;
	b=LusDxLebVib1+/MngA517OY44ByfTmFycuT5olTnIsu7p7+wR7wrLiEkoEj7Dx8ErY
	OI20VUJYQ0lpzJHPExs+8LC/oMW3zQl8oJsaQzPBwHHUGkTQiR082xfyEoYqeaODfTQv
	AJQV8qns1OWk81JHLIoMVHKur8GW9omVOV5bw=
MIME-Version: 1.0
Sender: amdragon@gmail.com
In-Reply-To: <1304723846-29134-2-git-send-email-flo@chaoflow.net>
References: <1304723846-29134-1-git-send-email-flo@chaoflow.net>
	<1304723846-29134-2-git-send-email-flo@chaoflow.net>
Date: Fri, 6 May 2011 19:55:26 -0400
Message-ID: <BANLkTime86NE4W5j+p0uJiR5_cF3gZVd8Q@mail.gmail.com>
Subject: Re: [PATCH] implement search --format=sanitized_text + emacs UI to
	use it
From: Austin Clements <amdragon@mit.edu>
To: Florian Friesdorf <flo@chaoflow.net>
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable
Cc: notmuch@notmuchmail.org, a.amann@ucc.ie
Precedence: list

Perhaps text summary output should *always* do this.  The text summary
format is meant half for user consumption and half for emacs
consumption and allowing newlines that don't indicate the end of a
summary line seems bad for *both* use cases.

On Fri, May 6, 2011 at 7:17 PM, Florian Friesdorf <flo@chaoflow.net> wrote:
> Sanitize "Subject:" and "Author:" fields to not contain control
> characters for sanitized_text format.
>
> When a Subject field contains encoded CRLF sequences, these sequences
> would appear unfiltered in the output of notmuch search. This confused
> the notmuch emacs interface leading to "Unexpected Output"
> messages. This is now fixed by replacing all characters with ASCII
> code less than 32 with a question mark for the sanitized_text
> format. The emacs UI uses this format.
>
> Thank you to Andreas Amann <a.amann@ucc.ie>, who wrote the initial
> patch, I just turned it into a new format.
>
> missing:
> - man page update
> - test, (works for me)
> - investigate initialization warning:
> CC -O2 notmuch-search.o
> notmuch-search.c:98:1: warning: missing initializer
> notmuch-search.c:98:1: warning: (near initialization for
> 'format_sanitized_text.results_null')
> ---
> =A0emacs/notmuch.el | =A0 =A03 +-
> =A0notmuch-search.c | =A0 58 ++++++++++++++++++++++++++++++++++++++++++++=
++++++++++
> =A02 files changed, 60 insertions(+), 1 deletions(-)
>
> diff --git a/emacs/notmuch.el b/emacs/notmuch.el
> index 1d683f8..9d7c212 100644
> --- a/emacs/notmuch.el
> +++ b/emacs/notmuch.el
> @@ -879,7 +879,8 @@ The optional parameters are used as follows:
> =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 (if oldest-first
> =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 "--sort=3Doldest-first"
> =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 "--sort=3Dnewest-first")
> - =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0query)))
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 "--format=3Dsanitized_text"
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 query)))
> =A0 =A0 =A0 =A0 =A0(set-process-sentinel proc 'notmuch-search-process-sen=
tinel)
> =A0 =A0 =A0 =A0 =A0(set-process-filter proc 'notmuch-search-process-filte=
r))))
> =A0 =A0 (run-hooks 'notmuch-search-hook)))
> diff --git a/notmuch-search.c b/notmuch-search.c
> index 5e39511..d59dc44 100644
> --- a/notmuch-search.c
> +++ b/notmuch-search.c
> @@ -78,6 +78,26 @@ static const search_format_t format_text =3D {
> =A0};
>
> =A0static void
> +format_thread_sanitized_text (const void *ctx,
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const char *thr=
ead_id,
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const time_t da=
te,
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const int match=
ed,
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const int total=
,
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const char *aut=
hors,
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const char *sub=
ject);
> +static const search_format_t format_sanitized_text =3D {
> + =A0 =A0"",
> + =A0 =A0 =A0 "",
> + =A0 =A0 =A0 =A0 =A0 format_item_id_text,
> + =A0 =A0 =A0 =A0 =A0 format_thread_sanitized_text,
> + =A0 =A0 =A0 =A0 =A0 " (",
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 "%s", " ",
> + =A0 =A0 =A0 =A0 =A0 ")", "\n",
> + =A0 =A0 =A0 "",
> + =A0 =A0"",
> +};
> +
> +static void
> =A0format_item_id_json (const void *ctx,
> =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const char *item_type,
> =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const char *item_id);
> @@ -129,6 +149,42 @@ format_thread_text (const void *ctx,
> =A0 =A0 =A0 =A0 =A0 =A0subject);
> =A0}
>
> +static char *
> +sanitize_string(const void *ctx, const char *str)
> +{
> + =A0 =A0char *out, *loop;
> +
> + =A0 =A0loop =3D out =3D talloc_strdup (ctx, str);
> +
> + =A0 =A0for(;*loop;loop++){
> + =A0 =A0 =A0 if ((unsigned char)(*loop) < 32)
> + =A0 =A0 =A0 =A0 =A0 *loop =3D '?';
> + =A0 =A0}
> + =A0 =A0return out;
> +}
> +
> +static void
> +format_thread_sanitized_text (const void *ctx,
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const char *thr=
ead_id,
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const time_t da=
te,
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const int match=
ed,
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const int total=
,
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const char *aut=
hors,
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 const char *sub=
ject)
> +{
> + =A0 =A0void *ctx_quote =3D talloc_new (ctx);
> +
> + =A0 =A0printf ("thread:%s %12s [%d/%d] %s; %s",
> + =A0 =A0 =A0 =A0 =A0 thread_id,
> + =A0 =A0 =A0 =A0 =A0 notmuch_time_relative_date (ctx, date),
> + =A0 =A0 =A0 =A0 =A0 matched,
> + =A0 =A0 =A0 =A0 =A0 total,
> + =A0 =A0 =A0 =A0 =A0 sanitize_string(ctx_quote, authors),
> + =A0 =A0 =A0 =A0 =A0 sanitize_string(ctx_quote, subject));
> +
> + =A0 =A0talloc_free (ctx_quote);
> +}
> +
> =A0static void
> =A0format_item_id_json (const void *ctx,
> =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 unused (const char *item_type),
> @@ -378,6 +434,8 @@ notmuch_search_command (void *ctx, int argc, char *ar=
gv[])
> =A0 =A0 =A0 =A0 =A0 =A0opt =3D argv[i] + sizeof ("--format=3D") - 1;
> =A0 =A0 =A0 =A0 =A0 =A0if (strcmp (opt, "text") =3D=3D 0) {
> =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0format =3D &format_text;
> + =A0 =A0 =A0 =A0 =A0 } else if (strcmp (opt, "sanitized_text") =3D=3D 0)=
 {
> + =A0 =A0 =A0 =A0 =A0 =A0 =A0 format =3D &format_sanitized_text;
> =A0 =A0 =A0 =A0 =A0 =A0} else if (strcmp (opt, "json") =3D=3D 0) {
> =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0format =3D &format_json;
> =A0 =A0 =A0 =A0 =A0 =A0} else {
> --
> 1.7.5.1
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch
>