add TODO

[muttjump] / muttjump

diff --git a/muttjump b/muttjump
index 50ca34a63434997c00e61a573660a1929078c725..3cdb6ed10bc25e49463b17864a905985518da7ed 100755 (executable)
--- a/muttjump
+++ b/muttjump
@@ -26,7 +26,7 @@ MUTTJUMP_MODE=${MUTTJUMP_MODE:-search}
 
 # "yes", "no" or "auto"
 # If set to "auto", the $STY environment variable is used for auto detection.
 
 # "yes", "no" or "auto"
 # If set to "auto", the $STY environment variable is used for auto detection.

-MUTTJUMP_USE_SCREEN="auto"
+MUTTJUMP_USE_SCREEN=${MUTTJUMP_USE_SCREEN:-auto}

 
 # "yes" or "no"
 # If this is set to "yes", muttjump will not open a new instance of
 
 # "yes" or "no"
 # If this is set to "yes", muttjump will not open a new instance of


@@ -36,11 +36,8 @@ MUTTJUMP_USE_SCREEN="auto"
 #            for this to work!
 MUTTJUMP_MULTI_SCREEN_MODE=${MUTTJUMP_MULTI_SCREEN_MODE:-no}
 
 #            for this to work!
 MUTTJUMP_MULTI_SCREEN_MODE=${MUTTJUMP_MULTI_SCREEN_MODE:-no}
 

-# name of the screen session (screen -S ...), leave blank for none
-MUTTJUMP_SCREEN_SESSION=${MUTTJUMP_SCREEN_SESSION:-}
-

 # function to create the screen window name from the full path of the mailbox
 # function to create the screen window name from the full path of the mailbox

-if ! type -p MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE >/dev/null ; then
+if ! type MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE >/dev/null 2>&1 ; then

     function MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE () {
         basename "$1"
     }
     function MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE () {
         basename "$1"
     }


@@ -54,6 +51,8 @@ NMZMAIL=${NMZMAIL:-nmzmail}
 SCREEN=${SCREEN:-screen}
 FORMAIL=${FORMAIL:-formail}
 REFORMAIL=${REFORMAIL:-reformail}
 SCREEN=${SCREEN:-screen}
 FORMAIL=${FORMAIL:-formail}
 REFORMAIL=${REFORMAIL:-reformail}

+WHIPTAIL=${WHIPTAIL:-whiptail --noitem}
+DIALOG=${DIALOG:-dialog}

 
 function die () {
     echo -e >&2 "$0: $1"
 
 function die () {
     echo -e >&2 "$0: $1"


@@ -64,20 +63,52 @@ function quote () {
     echo \'${1//\'/\'\\\'\'}\'
 }
 
     echo \'${1//\'/\'\\\'\'}\'
 }
 

+function quote_regexp () {
+    echo "$1" | sed 's/[][\^.$|)(*+?}{]/\\&/g'
+}
+

 function is_callable () {
 function is_callable () {

-    type -p $1 >/dev/null
+    type $1 >/dev/null 2>&1

 }
 
 }
 

-# Check command-line arguments and STDIN
-if tty -s || [ $# -ne 0 ] ; then
+function wc_L () {
+    awk '{ y = length(); if (y > x) x = y } END { print x }'
+}
+
+function usage () {

     cat >&2 <<END
     cat >&2 <<END

-Usage: $0 < msg
+Usage: muttjump msgid
+       cat msg | muttjump [-R]

 
 

-This script calls mutt, jumping to the message given in stdin.
-Uses a mail search engine (currently mairix, mu and nmzmail are supported),
+This script calls mutt, jumping to the message given in stdin or to the message
+identified by "msgid".  With "-R", it jumps to the message being replied to.
+It uses a mail search engine (currently mairix, mu and nmzmail are supported),

 which has to be configured through MUTTJUMP_INDEXER variable.
 END
     exit 1
 which has to be configured through MUTTJUMP_INDEXER variable.
 END
     exit 1

+}
+
+function reopen_tty () {
+    # Close message-stdin and open terminal-stdin instead.
+    # mutt behaves different if STDIN is no terminal
+    # TODO: Find cleaner solution (e.g. mutt command-line argument?)
+    exec 0<&-
+    term="/dev/$(ps -p$$ -otty=)"
+    exec < $term
+}
+
+
+# Check command-line arguments and STDIN
+search_header="Message-ID"
+if tty -s ; then
+    [ $# -ne 1 ] && usage
+else
+    [ $# -gt 1 ] && usage
+    if [ $# -eq 1 ] ; then
+        [ "$1" != "-R" ] && usage
+        search_header="In-Reply-To"
+        shift
+    fi

 fi
 
 # check if mutt is installed
 fi
 
 # check if mutt is installed


@@ -85,6 +116,13 @@ if ! is_callable $MUTT ; then
     die "$MUTT is not in PATH, set MUTT variable"
 fi
 
     die "$MUTT is not in PATH, set MUTT variable"
 fi
 

+DIALOG_PROG=""
+if is_callable $WHIPTAIL ; then
+    DIALOG_PROG=$WHIPTAIL
+elif is_callable $DIALOG ; then
+    DIALOG_PROG=$DIALOG
+fi
+

 case $MUTTJUMP_MODE in
     limit|search)
         ;;
 case $MUTTJUMP_MODE in
     limit|search)
         ;;


@@ -94,35 +132,45 @@ case $MUTTJUMP_MODE in
 esac
 
 # search for Message-ID in STDIN
 esac
 
 # search for Message-ID in STDIN

-if is_callable $FORMAIL ; then
-    msgid=$($FORMAIL -c -z -x Message-ID | head -n1)
+if [ $# -eq 1 ] ; then
+    msgid=$1
+elif is_callable $FORMAIL ; then
+    msgid=$($FORMAIL -c -z -x $search_header | head -n1)

 elif is_callable $REFORMAIL ; then
 elif is_callable $REFORMAIL ; then

-    msgid=$($REFORMAIL -c -x Message-ID: | head -n1)
+    msgid=$($REFORMAIL -c -x $search_header: | head -n1)

 else
 else

-    msgid=$(sed -n 's/^Message-ID:[ \t]*\(.*\)/\1/Ip' | head -n1)
+    msgid=$(sed -n 's/^'$search_header':[ \t]*\(.*\)/\1/Ip' | head -n1)

 fi
 if [ -z "$msgid" ] ; then
 fi
 if [ -z "$msgid" ] ; then

-    die "could not find Message-ID header in standard input"
+    die "could not find $search_header header in standard input"

 fi
 fi

-msgid_clean=$(echo "$msgid" | sed 's/^<\(.*\)>$/\1/')
+msgid_quoted=$(quote_regexp "$msgid")
+msgid_clean=$(echo "$msgid" | sed -e 's/^<//' -e 's/>$//')

 
 # try to locate path of message using a mail search engine
 case $MUTTJUMP_INDEXER in
     mairix)
 
 # try to locate path of message using a mail search engine
 case $MUTTJUMP_INDEXER in
     mairix)

-        orig_msgfile=$($MAIRIX -r "m:$msgid_clean" | head -n1)
+        msgid_mairix=$msgid_clean
+        # mairix can't quote special characters (~,/=^) in search words. As a
+        # workaround, split Message-ID in 31-character long AND-linked
+        # substrings.
+        if echo "$msgid_clean" | grep -q '[~,/=^]' ; then
+            msgid_mairix=$(echo "$msgid_clean" | sed -e 's/[~,/=^]\+/ /g' \
+                -e 's/[^ ]\{31\}/& /g' -e 's/^ \+//g' -e 's/ *$/=/g' \
+                -e 's/ /=,/g')
+        fi
+        orig_msgfiles=$($MAIRIX -r "m:$msgid_mairix")

         ;;
     mu)
         ;;
     mu)

-        orig_msgfile=$($MU find -f l "i:$msgid_clean" |
-            grep -v "^\*\*" | head -n1)
+        orig_msgfiles=$($MU find -f l "i:$msgid_clean" | grep -v "^\*\*")

         ;;
     mu-old)
         ;;
     mu-old)

-        orig_msgfile=$($MU find -f p "m:$msgid_clean" | head -n1)
+        orig_msgfiles=$($MU find -f p "m:$msgid_clean")

         ;;
     nmzmail)
         nmzmail_results=$(mktemp -d)
         ;;
     nmzmail)
         nmzmail_results=$(mktemp -d)

-        echo "+message-id:$msgid" | $NMZMAIL -n 1 -r "$nmzmail_results"
-        msgfile=$(find "$nmzmail_results" -type l | head -n1)
-        orig_msgfile=$(readlink "$msgfile")
+        echo "+message-id:/^$msgid_quoted$/" | $NMZMAIL -r "$nmzmail_results"
+        orig_msgfiles=$(find "$nmzmail_results" -type l -exec readlink {} \;)

         rm -rf "$nmzmail_results"
         ;;
     "")
         rm -rf "$nmzmail_results"
         ;;
     "")


@@ -133,17 +181,41 @@ case $MUTTJUMP_INDEXER in
         ;;
 esac
 
         ;;
 esac
 

-if [ -z "$orig_msgfile" -o ! -e "$orig_msgfile" ] ; then
+if [ -z "$orig_msgfiles" ] ; then

     die "no message with msgid $msgid found!"
 fi
 
     die "no message with msgid $msgid found!"
 fi
 

-# get containing maildir of $orig_msgfile
-orig_maildir=$(dirname "$(dirname "$orig_msgfile")")
+count=$(echo "$orig_msgfiles" | wc -l)
+if [ $count -gt 1 -a -n "$DIALOG_PROG" ] ; then
+    choices=$(echo "$orig_msgfiles" | while read line ;
+        do dirname "$(dirname "$line")" ; echo . ; done)
+    maxwidth=$(echo "$choices" | wc_L)
+    orig_maildir=$($DIALOG_PROG --clear --title "More than one mailbox found" \
+        --menu "Select mailbox:" $((count+8)) $((maxwidth+16)) \
+        $count $choices 3>&2 2>&1 1>&3-)
+elif [ $count -gt 1 ] ; then
+    choices=()
+    while read line ; do
+        choices=("${choices[@]}" "$(dirname "$(dirname "$line")")")
+    done <<<"$orig_msgfiles"
+    echo "More than one mailbox found"
+    echo "Select mailbox:"
+    select md in "${choices[@]}" ; do
+        orig_maildir=$md
+        break
+    done <> /dev/tty
+else
+    orig_msgfile=$orig_msgfiles
+    # get containing maildir of $orig_msgfile
+    orig_maildir=$(dirname "$(dirname "$orig_msgfile")")
+fi
+

 if [ ! -d "$orig_maildir/cur" ] ; then
     die "directory $(quote "$orig_maildir") doesn't exist or is no Maildir"
 fi
 
 if [ ! -d "$orig_maildir/cur" ] ; then
     die "directory $(quote "$orig_maildir") doesn't exist or is no Maildir"
 fi
 

-jump_expr="~i'$msgid'"
+msgid_mutt=$(quote_regexp "$msgid_quoted")
+jump_expr="~i'$msgid_mutt'"

 
 if [ "$MUTTJUMP_MULTI_SCREEN_MODE" = no ] ; then
 
 
 if [ "$MUTTJUMP_MULTI_SCREEN_MODE" = no ] ; then
 


@@ -158,17 +230,16 @@ if [ "$MUTTJUMP_MULTI_SCREEN_MODE" = no ] ; then
 
     screen_opts=()
     if [ "$MUTTJUMP_USE_SCREEN" = yes ] ; then
 
     screen_opts=()
     if [ "$MUTTJUMP_USE_SCREEN" = yes ] ; then

-        [ -n "$STY" ] && screen_opts=("-X" "screen")
+        if [ -n "$STY" ] ; then
+            screen_opts=("-X" "screen")
+        else
+            reopen_tty
+        fi

         screen_window_name=$(MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE "$orig_maildir")
         screen_opts=("${screen_opts[@]}" "-t" "$screen_window_name")
     else
         SCREEN=""
         screen_window_name=$(MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE "$orig_maildir")
         screen_opts=("${screen_opts[@]}" "-t" "$screen_window_name")
     else
         SCREEN=""

-        # Close message-stdin and open terminal-stdin instead.
-        # mutt behaves different if STDIN is no terminal
-        # TODO: Find cleaner solution (e.g. mutt command-line argument?)
-        exec 0<&-
-        term="/dev/$(ps -p$$ -otty=)"
-        exec < $term
+        reopen_tty

     fi
 
     # start mutt, open original folder and jump to the original message
     fi
 
     # start mutt, open original folder and jump to the original message


@@ -182,16 +253,6 @@ else
     fi
 
     screen_window_name=$(MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE "$orig_maildir")
     fi
 
     screen_window_name=$(MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE "$orig_maildir")

-    screen_opts=()
-    if [ -n "$MUTTJUMP_SCREEN_SESSION" ] ; then
-        screen_opts=("-S" "$MUTTJUMP_SCREEN_SESSION")
-        screen_opts_str="-S $(quote "$MUTTJUMP_SCREEN_SESSION")"
-    fi

 
 

-    $SCREEN "${screen_opts[@]}" -p "$screen_window_name" -X eval "select '$screen_window_name'" "stuff \"$jump_cmd\""
-
-    if [ $? != 0 ] ; then
-        die "You have to manually start a screen session with:
-$SCREEN $screen_opts_str -t $(quote "$screen_window_name") $MUTT -f $(quote "$orig_maildir")"
-    fi
+    $SCREEN -p "$screen_window_name" -X eval "select '$screen_window_name'" "stuff \"$jump_cmd\""

 fi
 fi