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