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

Benjamin Mako Hill || Want to submit a patch?