projects.mako.cc - muttjump/blob - muttjump

   1 #!/bin/bash
   2 # written by Johannes Weißl
   3
   4 # muttjump
   5 #
   6 # This script makes mail indexers (like mairix, mu or nmzmail) together with
   7 # mutt more useful.
   8 #
   9 # These search engines usually create a virtual maildir containing symbolic
  10 # links to the original mails, which can be browsed using mutt.
  11 # It would be optimal if mutt somehow knew that the two maildir entries
  12 # identify the same mail, but this is not that easy (mail folder
  13 # abstraction from different formats, no tight integration of mail indexers).
  14 #
  15 # So if one wants to rename (for setting/clearing flags), delete or edit the
  16 # mails, it is only possible using the original mail. This (very simple)
  17 # script helps to jump to this message, using e.g. this macro in .muttrc:
  18 #
  19 # macro generic ,j "<enter-command>push <pipe-message>muttjump<enter><enter>" "jump to original message"
  20
  21 # one of: mairix, mu, mu-old (mu < 0.7) and nmzmail
  22 MUTTJUMP_INDEXER=${MUTTJUMP_INDEXER:-}
  23
  24 # "limit" or "search" (default)
  25 MUTTJUMP_MODE=${MUTTJUMP_MODE:-search}
  26
  27 # "yes", "no" or "auto"
  28 # If set to "auto", the $STY environment variable is used for auto detection.
  29 MUTTJUMP_USE_SCREEN=${MUTTJUMP_USE_SCREEN:-auto}
  30
  31 # "yes" or "no"
  32 # Set this to "yes" if you want exactly one screen window (with mutt running
  33 # inside) per mailbox. With new versions of screen (> 4.00) it is possible
  34 # to do that automatically, with old versions you have to start them
  35 # manually! Setting this to yes implies MUTTJUMP_USE_SCREEN=yes.
  36 MUTTJUMP_MULTI_SCREEN_MODE=${MUTTJUMP_MULTI_SCREEN_MODE:-no}
  37
  38 # function to create the screen window name from the full path of the mailbox
  39 if ! type MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE >/dev/null 2>&1 ; then
  40     function MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE () {
  41         basename "$1"
  42     }
  43 fi
  44
  45 # Version of GNU screen
  46 # Since 4.01.00devel (commit d87a0d8) backslash handling was altered.
  47 MUTTJUMP_SCREEN_VERSION=${MUTTJUMP_SCREEN_VERSION:-auto}
  48
  49 # program paths
  50 MUTT=${MUTT:-mutt}
  51 MAIRIX=${MAIRIX:-mairix}
  52 MU=${MU:-mu}
  53 NMZMAIL=${NMZMAIL:-nmzmail}
  54 SCREEN=${SCREEN:-screen}
  55 FORMAIL=${FORMAIL:-formail}
  56 REFORMAIL=${REFORMAIL:-reformail}
  57 WHIPTAIL=${WHIPTAIL:-whiptail --noitem}
  58 DIALOG=${DIALOG:-dialog}
  59
  60 function die () {
  61     echo -e >&2 "$0: $1"
  62     exit 1
  63 }
  64
  65 function quote () {
  66     echo \'${1//\'/\'\\\'\'}\'
  67 }
  68
  69 function quote_regexp () {
  70     echo "$1" | sed 's/[][\^.$|)(*+?}{]/\\&/g'
  71 }
  72
  73 function is_callable () {
  74     type $1 >/dev/null 2>&1
  75 }
  76
  77 function wc_L () {
  78     awk '{ y = length(); if (y > x) x = y } END { print x }'
  79 }
  80
  81 function is_new_screen () {
  82     sv=$MUTTJUMP_SCREEN_VERSION
  83     if [ "$sv" = auto ] ; then
  84         sv=$($SCREEN --version | awk '{print $3}')
  85     fi
  86     echo "$sv" | grep -vq "^\(4\.00\|[0-3]\.\)"
  87 }
  88
  89 function usage () {
  90     cat >&2 <<END
  91 Usage: muttjump msgid
  92        cat msg | muttjump [-R]
  93
  94 This script calls mutt, jumping to the message given in stdin or to the message
  95 identified by "msgid".  With "-R", it jumps to the message being replied to.
  96 It uses a mail search engine (currently mairix, mu and nmzmail are supported),
  97 which has to be configured through MUTTJUMP_INDEXER variable.
  98 END
  99     exit 1
 100 }
 101
 102 function reopen_tty () {
 103     # Close message-stdin and open terminal-stdin instead.
 104     # mutt behaves different if STDIN is no terminal
 105     # TODO: Find cleaner solution (e.g. mutt command-line argument?)
 106     exec 0<&-
 107     term="/dev/$(ps -p$$ -otty=)"
 108     exec < $term
 109 }
 110
 111
 112 # Check command-line arguments and STDIN
 113 search_header="Message-ID"
 114 if tty -s ; then
 115     [ $# -ne 1 ] && usage
 116 else
 117     [ $# -gt 1 ] && usage
 118     if [ $# -eq 1 ] ; then
 119         [ "$1" != "-R" ] && usage
 120         search_header="In-Reply-To"
 121         shift
 122     fi
 123 fi
 124
 125 # check if mutt is installed
 126 if ! is_callable $MUTT ; then
 127     die "$MUTT is not in PATH, set MUTT variable"
 128 fi
 129
 130 DIALOG_PROG=""
 131 if is_callable $WHIPTAIL ; then
 132     DIALOG_PROG=$WHIPTAIL
 133 elif is_callable $DIALOG ; then
 134     DIALOG_PROG=$DIALOG
 135 fi
 136
 137 case $MUTTJUMP_MODE in
 138     limit|search)
 139         ;;
 140     *)
 141         die "variable MUTTJUMP_MODE must be set to \"limit\" or \"search\""
 142         ;;
 143 esac
 144
 145 # search for Message-ID in STDIN
 146 if [ $# -eq 1 ] ; then
 147     msgid=$1
 148 elif is_callable $FORMAIL ; then
 149     msgid=$($FORMAIL -c -z -x $search_header | head -n1)
 150 elif is_callable $REFORMAIL ; then
 151     msgid=$($REFORMAIL -c -x $search_header: | head -n1)
 152 else
 153     msgid=$(sed -n 's/^'$search_header':[ \t]*\(.*\)/\1/Ip' | head -n1)
 154 fi
 155 if [ -z "$msgid" ] ; then
 156     die "could not find $search_header header in standard input"
 157 fi
 158 msgid_quoted=$(quote_regexp "$msgid")
 159 msgid_clean=$(echo "$msgid" | sed -e 's/^<//' -e 's/>$//')
 160
 161 # try to locate path of message using a mail search engine
 162 case $MUTTJUMP_INDEXER in
 163     mairix)
 164         msgid_mairix=$msgid_clean
 165         # mairix can't quote special characters (~,/=^) in search words. As a
 166         # workaround, split Message-ID in 31-character long AND-linked
 167         # substrings.
 168         if echo "$msgid_clean" | grep -q '[~,/=^]' ; then
 169             msgid_mairix=$(echo "$msgid_clean" | sed -e 's/[~,/=^]\+/ /g' \
 170                 -e 's/[^ ]\{31\}/& /g' -e 's/^ \+//g' -e 's/ *$/=/g' \
 171                 -e 's/ /=,/g')
 172         fi
 173         orig_msgfiles=$($MAIRIX -r "m:$msgid_mairix")
 174         ;;
 175     mu)
 176         orig_msgfiles=$($MU find -f l "i:$msgid_clean" | grep -v "^\*\*")
 177         ;;
 178     mu-old)
 179         orig_msgfiles=$($MU find -f p "m:$msgid_clean")
 180         ;;
 181     nmzmail)
 182         nmzmail_results=$(mktemp -d)
 183         echo "+message-id:/^$msgid_quoted$/" | $NMZMAIL -r "$nmzmail_results"
 184         orig_msgfiles=$(find "$nmzmail_results" -type l -exec readlink {} \;)
 185         rm -rf "$nmzmail_results"
 186         ;;
 187     "")
 188         die "variable MUTTJUMP_INDEXER not set or empty"
 189         ;;
 190     *)
 191         die "unknown mail index program \"$MUTTJUMP_INDEXER\""
 192         ;;
 193 esac
 194
 195 if [ -z "$orig_msgfiles" ] ; then
 196     die "no message with msgid $msgid found!"
 197 fi
 198
 199 count=$(echo "$orig_msgfiles" | wc -l)
 200 if [ $count -gt 1 -a -n "$DIALOG_PROG" ] ; then
 201     choices=$(echo "$orig_msgfiles" | while read line ;
 202         do dirname "$(dirname "$line")" ; echo . ; done)
 203     maxwidth=$(echo "$choices" | wc_L)
 204     orig_maildir=$($DIALOG_PROG --clear --title "More than one mailbox found" \
 205         --menu "Select mailbox:" $((count+8)) $((maxwidth+16)) \
 206         $count $choices 3>&2 2>&1 1>&3-)
 207 elif [ $count -gt 1 ] ; then
 208     choices=()
 209     while read line ; do
 210         choices=("${choices[@]}" "$(dirname "$(dirname "$line")")")
 211     done <<<"$orig_msgfiles"
 212     echo "More than one mailbox found"
 213     echo "Select mailbox:"
 214     select md in "${choices[@]}" ; do
 215         orig_maildir=$md
 216         break
 217     done <> /dev/tty
 218 else
 219     orig_msgfile=$orig_msgfiles
 220     # get containing maildir of $orig_msgfile
 221     orig_maildir=$(dirname "$(dirname "$orig_msgfile")")
 222 fi
 223
 224 if [ ! -d "$orig_maildir/cur" ] ; then
 225     die "directory $(quote "$orig_maildir") doesn't exist or is no Maildir"
 226 fi
 227
 228 msgid_mutt=$(quote_regexp "$msgid_quoted")
 229 jump_expr="~i'$msgid_mutt'"
 230 jump_cmd="<limit>$jump_expr<enter>"
 231 if [ "$MUTTJUMP_MODE" = search ] ; then
 232     jump_cmd="$jump_cmd<limit>all<enter>"
 233 fi
 234
 235 if [ "$MUTTJUMP_MULTI_SCREEN_MODE" = yes ] ||
 236         [ "$MUTTJUMP_USE_SCREEN" = auto -a -n "$STY" ] ; then
 237     MUTTJUMP_USE_SCREEN=yes
 238 fi
 239
 240 screen_opts=()
 241 screen_query_arg=""
 242 if [ "$MUTTJUMP_USE_SCREEN" = yes ] ; then
 243     if [ -n "$STY" ] ; then
 244         screen_opts=("-X" "screen")
 245         if is_new_screen ; then
 246             jump_cmd=${jump_cmd/\\/\\\\\\}
 247             screen_query_arg="-Q"
 248         fi
 249     else
 250         reopen_tty
 251     fi
 252     screen_window_name=$(MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE "$orig_maildir")
 253     screen_opts=("${screen_opts[@]}" "-t" "$screen_window_name")
 254 else
 255     SCREEN=""
 256     reopen_tty
 257 fi
 258
 259 if [ "$MUTTJUMP_MULTI_SCREEN_MODE" = yes -a -n "$STY" ] ; then
 260     $SCREEN -X -p "$screen_window_name" $screen_query_arg \
 261             select "$screen_window_name" >/dev/null
 262     if [ $? = 0 ] ; then
 263         $SCREEN -X -p "$screen_window_name" stuff ":push \"$jump_cmd\"\r"
 264         exit 0
 265     fi
 266 fi
 267
 268 # start mutt, open original folder and jump to the original message
 269 $SCREEN "${screen_opts[@]}" $MUTT -f "$orig_maildir" -e "push \"$jump_cmd\""