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