[PATCH 1/3] emacs: Introduce generic boolean term escaping function

[PATCH 1/3] emacs: Introduce generic boolean term escaping function

[Austin Clements]

Currently, we only properly escape stashed id queries, but there are
other places where the Emacs UI constructs queries for boolean terms.
Since this escaping function is meant to be used in other places, it
avoids escaping strings that don't need escaping.
---
 emacs/notmuch-lib.el |   16 +++++++++++++++-
 test/emacs           |    2 +-
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el
index 69867ad..eeb005f 100644
--- a/emacs/notmuch-lib.el
+++ b/emacs/notmuch-lib.el
@@ -161,9 +161,23 @@ the user hasn't set this variable with the old or new value."
 	"[No Subject]"
       subject)))
 
+(defun notmuch-escape-boolean-term (term)
+  "Escape a boolean term for use in a query.
+
+The caller is responsible for prepending the term prefix and a
+colon.  This performs minimal escaping in order to produce
+user-friendly queries."
+
+  (save-match-data
+    (if (or (equal term "")
+	    (string-match "[ ()]\\|^\"" term))
+	;; Requires escaping
+	(concat "\"" (replace-regexp-in-string "\"" "\"\"" term t t) "\"")
+      term)))
+
 (defun notmuch-id-to-query (id)
   "Return a query that matches the message with id ID."
-  (concat "id:\"" (replace-regexp-in-string "\"" "\"\"" id t t) "\""))
+  (concat "id:" (notmuch-escape-boolean-term id)))
 
 ;;
 
diff --git a/test/emacs b/test/emacs
index 21f1d16..44f641e 100755
--- a/test/emacs
+++ b/test/emacs
@@ -667,7 +667,7 @@ Some One <someone@somewhere.org>
 Some One Else <notsomeone@somewhere.org>
 Notmuch <notmuch@notmuchmail.org>
 Stash my stashables
-id:"bought"
+id:bought
 bought
 inbox,stashtest
 ${gen_msg_filename}
-- 
1.7.10

[PATCH 2/3] emacs: Escape tag queries performed by hello

[Austin Clements]

---
 emacs/notmuch-hello.el |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/emacs/notmuch-hello.el b/emacs/notmuch-hello.el
index 052aaeb..be50aae 100644
--- a/emacs/notmuch-hello.el
+++ b/emacs/notmuch-hello.el
@@ -500,7 +500,7 @@ Complete list of currently available key bindings:
 (defun notmuch-hello-generate-tag-alist (&optional hide-tags)
   "Return an alist from tags to queries to display in the all-tags section."
   (mapcar (lambda (tag)
-	    (cons tag (format "tag:%s" tag)))
+	    (cons tag (concat "tag:" (notmuch-escape-boolean-term tag))))
 	  (notmuch-remove-if-not
 	   (lambda (tag)
 	     (not (member tag hide-tags)))
-- 
1.7.10

[PATCH 3/3] emacs: Escape tag queries suggested by tab completion

[Austin Clements]

---
 emacs/notmuch.el |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/emacs/notmuch.el b/emacs/notmuch.el
index a8a85ce..60e8bf9 100644
--- a/emacs/notmuch.el
+++ b/emacs/notmuch.el
@@ -917,7 +917,7 @@ PROMPT is the string to prompt with."
 	(append (list "folder:" "thread:" "id:" "date:" "from:" "to:"
 		      "subject:" "attachment:")
 		(mapcar (lambda (tag)
-			  (concat "tag:" tag))
+			  (concat "tag:" (notmuch-escape-boolean-term tag)))
 			(process-lines notmuch-command "search" "--output=tags" "*")))))
     (let ((keymap (copy-keymap minibuffer-local-map))
 	  (minibuffer-completion-table
-- 
1.7.10

Re: [PATCH 1/3] emacs: Introduce generic boolean term escaping function

[Tomi Ollila]

On Fri, Oct 26 2012, Austin Clements wrote:

> Currently, we only properly escape stashed id queries, but there are
> other places where the Emacs UI constructs queries for boolean terms.
> Since this escaping function is meant to be used in other places, it
> avoids escaping strings that don't need escaping.
> ---

These 3 patches LGTM.

Tomi


>  emacs/notmuch-lib.el |   16 +++++++++++++++-
>  test/emacs           |    2 +-
>  2 files changed, 16 insertions(+), 2 deletions(-)
>
> diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el
> index 69867ad..eeb005f 100644
> --- a/emacs/notmuch-lib.el
> +++ b/emacs/notmuch-lib.el
> @@ -161,9 +161,23 @@ the user hasn't set this variable with the old or new value."
>  	"[No Subject]"
>        subject)))
>  
> +(defun notmuch-escape-boolean-term (term)
> +  "Escape a boolean term for use in a query.
> +
> +The caller is responsible for prepending the term prefix and a
> +colon.  This performs minimal escaping in order to produce
> +user-friendly queries."
> +
> +  (save-match-data
> +    (if (or (equal term "")
> +	    (string-match "[ ()]\\|^\"" term))
> +	;; Requires escaping
> +	(concat "\"" (replace-regexp-in-string "\"" "\"\"" term t t) "\"")
> +      term)))
> +
>  (defun notmuch-id-to-query (id)
>    "Return a query that matches the message with id ID."
> -  (concat "id:\"" (replace-regexp-in-string "\"" "\"\"" id t t) "\""))
> +  (concat "id:" (notmuch-escape-boolean-term id)))
>  
>  ;;
>  
> diff --git a/test/emacs b/test/emacs
> index 21f1d16..44f641e 100755
> --- a/test/emacs
> +++ b/test/emacs
> @@ -667,7 +667,7 @@ Some One <someone@somewhere.org>
>  Some One Else <notsomeone@somewhere.org>
>  Notmuch <notmuch@notmuchmail.org>
>  Stash my stashables
> -id:"bought"
> +id:bought
>  bought
>  inbox,stashtest
>  ${gen_msg_filename}
> -- 
> 1.7.10
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

Re: [PATCH 1/3] emacs: Introduce generic boolean term escaping function

[Ethan Glasser-Camp]

Tomi Ollila <tomi.ollila@iki.fi> writes:

> These 3 patches LGTM.

Me too. But I wouldn't be averse to some tests :)

Ethan

Re: [PATCH 1/3] emacs: Introduce generic boolean term escaping function

[David Bremner]

Austin Clements <amdragon@MIT.EDU> writes:

> Currently, we only properly escape stashed id queries, but there are
> other places where the Emacs UI constructs queries for boolean terms.
> Since this escaping function is meant to be used in other places, it
> avoids escaping strings that don't need escaping.

Pushed all 3.

d