FIX: Handle special shell characters when filtering TERM.

The double quotes used in the filter_command erroneously expand $VARIABLE, and due to missing quoting in the eval() of filter_command, multiple spaces are condensed into a single space.
Introduce a new function shellquote() to correctly quote each filter TERM.

tests/t1260-listprj.sh

@@ -0,0 +1,42 @@
+#!/bin/sh
+
+test_description='list project functionality
+'
+. ./test-lib.sh
+
+cat > todo.txt <<EOF
+(B) smell the uppercase Roses +roses @outside +shared
+(C) notice the sunflowers +sunflowers @garden +shared +landscape
+stop
+EOF
+test_todo_session 'basic listproj' <<EOF
+>>> todo.sh listproj
++landscape
++roses
++shared
++sunflowers
+EOF
+
+test_todo_session 'listproj with context' <<EOF
+>>> todo.sh listproj @garden
++landscape
++shared
++sunflowers
+EOF
+
+TEST_TODO_CUSTOM=todo-custom.cfg
+cat todo.cfg > "$TEST_TODO_CUSTOM"
+cat >> "$TEST_TODO_CUSTOM" <<'EOF'
+export DEFAULT='</color>'
+export PRI_B='<color type=green>'
+export PRI_C='<color type=blue>'
+export TODOTXT_FINAL_FILTER='grep -i roses'
+EOF
+test_todo_session 'listproj with context special cases' <<EOF
+>>> todo.sh -+ -d "$TEST_TODO_CUSTOM" listproj @garden
++landscape
++shared
++sunflowers
+EOF
+
+test_done

tests/t1300-ls.sh

@@ -94,6 +94,40 @@ TODO: 1 of 3 tasks shown
 TODO: 1 of 3 tasks shown
 EOF
 
+#
+# check the filtering of TERM containing characters that are special to the
+# shell, like variables, quotes, and multiple subsequent spaces.
+#
+cat > todo.txt <<'EOF'
+earn some pennies
+earn some $$
+earn some "money"
+get money from O'Brian
+just get   money!
+EOF
+test_todo_session 'checking filtering of special characters' <<'EOF'
+>>> todo.sh ls '$$'
+2 earn some $$
+--
+TODO: 1 of 5 tasks shown
+
+>>> todo.sh ls '"money"'
+3 earn some "money"
+--
+TODO: 1 of 5 tasks shown
+
+>>> todo.sh ls "O'Brian"
+4 get money from O'Brian
+--
+TODO: 1 of 5 tasks shown
+
+>>> todo.sh ls "get   money"
+5 just get   money!
+--
+TODO: 1 of 5 tasks shown
+EOF
+
+
 #
 # check the x command line option
 #
@@ -142,7 +176,7 @@ cat > todo.txt <<EOF
 (D) @con02 +prj03 -- Some project 03 task, pri D
 (D) @con02 +prj04 -- Some project 04 task, pri D
 @con01 +prj01 -- Some project 01 task, no priority
-@con01 +prj02 -- Some project(S) 02 task, no priority
+@con01 +prj02 -- Some project 02 task, no priority
 @con02 +prj03 -- Some project 03 task, no priorty
 @con02 +prj04 -- Some project 04 task, no priority
 EOF
@@ -165,7 +199,7 @@ test_todo_session 'plain mode option' <<EOF
 15 (D) @con02 +prj03 -- Some project 03 task, pri D
 16 (D) @con02 +prj04 -- Some project 04 task, pri D
 17 @con01 +prj01 -- Some project 01 task, no priority
-18 @con01 +prj02 -- Some project(S) 02 task, no priority
+18 @con01 +prj02 -- Some project 02 task, no priority
 19 @con02 +prj03 -- Some project 03 task, no priorty
 20 @con02 +prj04 -- Some project 04 task, no priority
 --
@@ -189,7 +223,7 @@ TODO: 20 of 20 tasks shown
 15 (D) @con02 +prj03 -- Some project 03 task, pri D
 16 (D) @con02 +prj04 -- Some project 04 task, pri D
 17 @con01 +prj01 -- Some project 01 task, no priority
-18 @con01 +prj02 -- Some project(S) 02 task, no priority
+18 @con01 +prj02 -- Some project 02 task, no priority
 19 @con02 +prj03 -- Some project 03 task, no priorty
 20 @con02 +prj04 -- Some project 04 task, no priority
 --
@@ -217,7 +251,7 @@ cat > todo.txt <<EOF
 (D) @con02 +prj03 -- Some project 03 task, pri D
 (D) @con02 +prj04 -- Some project 04 task, pri D
 @con01 +prj01 -- Some project 01 task, no priority
-@con01 +prj02 -- Some project(S) 02 task, no priority
+@con01 +prj02 -- Some project 02 task, no priority
 @con02 +prj03 -- Some project 03 task, no priorty
 @con02 +prj04 -- Some project 04 task, no priority
 EOF
@@ -240,7 +274,7 @@ test_todo_session 'context, project, and priority suppression' <<EOF
 15 (D) @con02 +prj03 -- Some project 03 task, pri D
 16 (D) @con02 +prj04 -- Some project 04 task, pri D
 17 @con01 +prj01 -- Some project 01 task, no priority
-18 @con01 +prj02 -- Some project(S) 02 task, no priority
+18 @con01 +prj02 -- Some project 02 task, no priority
 19 @con02 +prj03 -- Some project 03 task, no priorty
 20 @con02 +prj04 -- Some project 04 task, no priority
 --
@@ -256,7 +290,7 @@ TODO: 20 of 20 tasks shown
 13 (D) @con01 +prj01 -- Some project 01 task, pri D
 14 (D) @con01 +prj02 -- Some project 02 task, pri D
 17 @con01 +prj01 -- Some project 01 task, no priority
-18 @con01 +prj02 -- Some project(S) 02 task, no priority
+18 @con01 +prj02 -- Some project 02 task, no priority
 --
 TODO: 10 of 20 tasks shown
 
@@ -270,7 +304,7 @@ TODO: 10 of 20 tasks shown
 13 @con01 +prj01 -- Some project 01 task, pri D
 14 @con01 +prj02 -- Some project 02 task, pri D
 17 @con01 +prj01 -- Some project 01 task, no priority
-18 @con01 +prj02 -- Some project(S) 02 task, no priority
+18 @con01 +prj02 -- Some project 02 task, no priority
 --
 TODO: 10 of 20 tasks shown
 
@@ -284,7 +318,7 @@ TODO: 10 of 20 tasks shown
 13 (D) @con01 -- Some project 01 task, pri D
 14 (D) @con01 -- Some project 02 task, pri D
 17 @con01 -- Some project 01 task, no priority
-18 @con01 -- Some project(S) 02 task, no priority
+18 @con01 -- Some project 02 task, no priority
 --
 TODO: 10 of 20 tasks shown
 
@@ -298,7 +332,7 @@ TODO: 10 of 20 tasks shown
 13 (D) +prj01 -- Some project 01 task, pri D
 14 (D) +prj02 -- Some project 02 task, pri D
 17 +prj01 -- Some project 01 task, no priority
-18 +prj02 -- Some project(S) 02 task, no priority
+18 +prj02 -- Some project 02 task, no priority
 --
 TODO: 10 of 20 tasks shown
 
@@ -312,7 +346,7 @@ TODO: 10 of 20 tasks shown
 13 +prj01 -- Some project 01 task, pri D
 14 +prj02 -- Some project 02 task, pri D
 17 +prj01 -- Some project 01 task, no priority
-18 +prj02 -- Some project(S) 02 task, no priority
+18 +prj02 -- Some project 02 task, no priority
 --
 TODO: 10 of 20 tasks shown
 
@@ -326,7 +360,7 @@ TODO: 10 of 20 tasks shown
 13 (D) @con01 +prj01 -- Some project 01 task, pri D
 14 (D) @con01 +prj02 -- Some project 02 task, pri D
 17 @con01 +prj01 -- Some project 01 task, no priority
-18 @con01 +prj02 -- Some project(S) 02 task, no priority
+18 @con01 +prj02 -- Some project 02 task, no priority
 --
 TODO: 10 of 20 tasks shown
 
@@ -340,7 +374,7 @@ TODO: 10 of 20 tasks shown
 13 -- Some project 01 task, pri D
 14 -- Some project 02 task, pri D
 17 -- Some project 01 task, no priority
-18 -- Some project(S) 02 task, no priority
+18 -- Some project 02 task, no priority
 --
 TODO: 10 of 20 tasks shown
 EOF

tests/t1330-ls-highlighting.sh

@@ -166,20 +166,4 @@ test_todo_session 'highlighting with hidden contexts/projects' <<EOF
 TODO: 4 of 4 tasks shown
 EOF
 
-# check that priorities are only matched at the start of the task
-#
-cat > todo.txt <<EOF
-(D) some prioritized task
-not prioritized
-should not be seen as PRIORITIZE(D) task
-EOF
-test_todo_session 'highlighting priority position' <<EOF
->>> todo.sh ls
-1 (D) some prioritized task
-2 not prioritized
-3 should not be seen as PRIORITIZE(D) task
---
-TODO: 3 of 3 tasks shown
-EOF
-
 test_done

todo.sh

@@ -59,7 +59,7 @@ shorthelp()
 		    listcon|lsc
 		    listfile|lf SRC [TERM...]
 		    listpri|lsp [PRIORITY] [TERM...]
-		    listproj|lsprj
+		    listproj|lsprj [TERM...]
 		    move|mv ITEM# DEST [SRC]
 		    prepend|prep ITEM# "TEXT TO PREPEND"
 		    pri|p ITEM# PRIORITY
@@ -633,6 +633,42 @@ _addto() {
     fi
 }
 
+shellquote()
+{
+    typeset -r qq=\'; printf %s\\n "'${1//\'/${qq}\\${qq}${qq}}'";
+}
+
+filtercommand()
+{
+    filter=${1:-}
+    shift
+    post_filter=${1:-}
+    shift
+
+    for search_term
+    do
+        ## See if the first character of $search_term is a dash
+        if [ "${search_term:0:1}" != '-' ]
+        then
+            ## First character isn't a dash: hide lines that don't match
+            ## this $search_term
+            filter="${filter:-}${filter:+ | }grep -i $(shellquote "$search_term")"
+        else
+            ## First character is a dash: hide lines that match this
+            ## $search_term
+            #
+            ## Remove the first character (-) before adding to our filter command
+            filter="${filter:-}${filter:+ | }grep -v -i '$(shellquote "${search_term:1}")'"
+        fi
+    done
+
+    [ -n "$post_filter" ] && {
+        filter="${filter:-}${filter:+ | }${post_filter:-}"
+    }
+
+    printf %s "$filter"
+}
+
 _list() {
     local FILE="$1"
     ## If the file starts with a "/" use absolute path. Otherwise,
@@ -656,32 +692,8 @@ _list() {
     ## Get our search arguments, if any
     shift ## was file name, new $1 is first search term
 
-    ## Prefix the filter_command with the pre_filter_command
-    filter_command="${pre_filter_command:-}"
-
-    for search_term
-    do
-        ## See if the first character of $search_term is a dash
-        if [ "${search_term:0:1}" != '-' ]
-        then
-            ## First character isn't a dash: hide lines that don't match
-            ## this $search_term
-            filter_command="${filter_command:-} ${filter_command:+|} \
-                grep -i \"$search_term\" "
-        else
-            ## First character is a dash: hide lines that match this
-            ## $search_term
-            #
-            ## Remove the first character (-) before adding to our filter command
-            filter_command="${filter_command:-} ${filter_command:+|} \
-                grep -v -i \"${search_term:1}\" "
-        fi
-    done
-
-    ## If post_filter_command is set, append it to the filter_command
-    [ -n "$post_filter_command" ] && {
-        filter_command="${filter_command:-}${filter_command:+ | }${post_filter_command:-}"
-    }
+    ## Build the filter.
+    filter_command=$(filtercommand "${pre_filter_command:-}" "${post_filter_command:-}" "$@")
 
     ## Figure out how much padding we need to use
     ## We need one level of padding for each power of 10 $LINES uses
@@ -699,7 +711,7 @@ _list() {
         | grep -v "^[ 0-9]\+ *$"
     )
     if [ "${filter_command}" ]; then
-        filtered_items=$(echo -n "$items" | eval ${filter_command})
+        filtered_items=$(echo -n "$items" | eval "${filter_command}")
     else
         filtered_items=$items
     fi
@@ -720,18 +732,17 @@ _list() {
                 return color
             }
             {
+                pos = match($0, /\([A-Z]\)/)
                 if (match($0, /^[0-9]+ x /)) {
                     print highlight("COLOR_DONE") $0 highlight("DEFAULT")
-                } else if (match($0, /^[0-9]+ \([A-Z]\) /)) {
-                    clr = highlight("PRI_" substr($0, RSTART + RLENGTH - 3, 1))
-                    print \
-                        (clr ? clr : highlight("PRI_X")) \
-                        (ENVIRON["HIDE_PRIORITY_SUBSTITUTION"] == "" ? $0 : substr($0, 1, RLENGTH - 4) substr($0, RSTART + RLENGTH)) \
-                        highlight("DEFAULT")
+                } else if (pos > 0) {
+                    clr = highlight("PRI_" substr($0, pos+1, 1))
+                    print ( clr ? clr : highlight("PRI_X") ) $0 highlight("DEFAULT")
                 } else { print }
             }
           '''  \
         | sed '''
+            s/'${HIDE_PRIORITY_SUBSTITUTION:-^}'//g
             s/'${HIDE_PROJECTS_SUBSTITUTION:-^}'//g
             s/'${HIDE_CONTEXTS_SUBSTITUTION:-^}'//g
           '''                                                   \
@@ -753,7 +764,7 @@ _list() {
     fi
 }
 
-export -f cleaninput _list die
+export -f cleaninput shellquote filtercommand _list die
 
 # == HANDLE ACTION ==
 action=$( printf "%s\n" "$ACTION" | tr 'A-Z' 'a-z' )
@@ -1008,7 +1019,8 @@ case $action in
     ;;
 
 "listproj" | "lsprj" )
-    grep -o '[^ ]*+[^ ]\+' "$TODO_FILE" | grep '^+' | sort -u
+    shift
+    eval "$(filtercommand 'cat "$TODO_FILE"' '' "$@")" | grep -o '[^ ]*+[^ ]\+' | grep '^+' | sort -u
     ;;
 
 "listpri" | "lsp" )