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

Benjamin Mako Hill || Want to submit a patch?