use array=() instead of declare -a
[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" or "no"
28 # If this is set to "yes", muttjump will not open a new instance of
29 # mutt, but instead jump to the original message in a running mutt
30 # (which is running in a screen session).
31 # ATTENTION: You need to have one mutt instance open for every mailbox
32 #            for this to work!
33 MUTTJUMP_MULTI_SCREEN_MODE=${MUTTJUMP_MULTI_SCREEN_MODE:-no}
34
35 # name of the screen session (screen -S ...), leave blank for none
36 MUTTJUMP_SCREEN_SESSION=${MUTTJUMP_SCREEN_SESSION:-}
37
38 # function to create the screen window name from the full path of the mailbox
39 if ! type -p MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE >/dev/null ; then
40     function MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE () {
41         basename "$1"
42     }
43 fi
44
45 # program paths
46 MUTT=${MUTT:-mutt}
47 MAIRIX=${MAIRIX:-mairix}
48 MU=${MU:-mu}
49 NMZMAIL=${NMZMAIL:-nmzmail}
50 SCREEN=${SCREEN:-screen}
51 FORMAIL=${FORMAIL:-formail}
52 REFORMAIL=${REFORMAIL:-reformail}
53
54 function die () {
55     echo -e >&2 "$0: $1"
56     exit 1
57 }
58
59 function quote () {
60     echo \'${1//\'/\'\\\'\'}\'
61 }
62
63 function is_callable () {
64     type -p $1 >/dev/null
65 }
66
67 # Check command-line arguments and STDIN
68 if tty -s || [ $# -ne 0 ] ; then
69     cat >&2 <<END
70 Usage: $0 < msg
71
72 This script calls mutt, jumping to the message given in stdin.
73 Uses a mail search engine (currently mairix, mu and nmzmail are supported),
74 which has to be configured through MUTTJUMP_INDEXER variable.
75 END
76     exit 1
77 fi
78
79 # check if mutt is installed
80 if ! is_callable $MUTT ; then
81     die "$MUTT is not in PATH, set MUTT variable"
82 fi
83
84 case $MUTTJUMP_MODE in
85     limit|search)
86         ;;
87     *)
88         die "variable MUTTJUMP_MODE must be set to \"limit\" or \"search\""
89         ;;
90 esac
91
92 # search for Message-ID in STDIN
93 if is_callable $FORMAIL ; then
94     msgid=$($FORMAIL -c -z -x Message-ID | head -n1)
95 elif is_callable $REFORMAIL ; then
96     msgid=$($REFORMAIL -c -x Message-ID: | head -n1)
97 else
98     msgid=$(sed -n 's/^Message-ID:[ \t]*\(.*\)/\1/Ip' | head -n1)
99 fi
100 if [ -z "$msgid" ] ; then
101     die "could not find Message-ID header in standard input"
102 fi
103 msgid_clean=$(echo "$msgid" | sed 's/^<\(.*\)>$/\1/')
104
105 # try to locate path of message using a mail search engine
106 case $MUTTJUMP_INDEXER in
107     mairix)
108         orig_msgfile=$($MAIRIX -r "m:$msgid_clean" | head -n1)
109         ;;
110     mu)
111         orig_msgfile=$($MU find -f l "i:$msgid_clean" |
112             grep -v "^\*\*" | head -n1)
113         ;;
114     mu-old)
115         orig_msgfile=$($MU find -f p "m:$msgid_clean" | head -n1)
116         ;;
117     nmzmail)
118         nmzmail_results=$(mktemp -d)
119         echo "+message-id:$msgid" | $NMZMAIL -n 1 -r "$nmzmail_results"
120         msgfile=$(find "$nmzmail_results" -type l | head -n1)
121         orig_msgfile=$(readlink "$msgfile")
122         rm -rf "$nmzmail_results"
123         ;;
124     "")
125         die "variable MUTTJUMP_INDEXER not set or empty"
126         ;;
127     *)
128         die "unknown mail index program \"$MUTTJUMP_INDEXER\""
129         ;;
130 esac
131
132 if [ -z "$orig_msgfile" -o ! -e "$orig_msgfile" ] ; then
133     die "no message with msgid $msgid found!"
134 fi
135
136 # get containing maildir of $orig_msgfile
137 orig_maildir=$(dirname "$(dirname "$orig_msgfile")")
138 if [ ! -d "$orig_maildir/cur" ] ; then
139     die "directory $(quote "$orig_maildir") doesn't exist or is no Maildir"
140 fi
141
142 jump_expr="~i'$msgid'"
143
144 if [ "$MUTTJUMP_MULTI_SCREEN_MODE" = no ] ; then
145
146     jump_cmd="<limit>$jump_expr<enter>"
147     if [ "$MUTTJUMP_MODE" = search ] ; then
148         jump_cmd="$jump_cmd<limit>all<enter>"
149     fi
150
151     # Close message-stdin and open terminal-stdin instead.
152     # mutt behaves different if STDIN is no terminal
153     # TODO: Find cleaner solution (e.g. mutt command-line argument?)
154     exec 0<&-
155     term="/dev/$(ps -p$$ -otty=)"
156     exec < $term
157
158     # start mutt, open original folder and jump to the original message
159     $MUTT -f "$orig_maildir" -e "push \"$jump_cmd\""
160
161 else
162
163     jump_cmd="l$jump_expr\r"
164     if [ "$MUTTJUMP_MODE" = search ] ; then
165         jump_cmd="${jump_cmd}lall\r"
166     fi
167
168     screen_window_name=$(MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE "$orig_maildir")
169     screen_opts=()
170     if [ -n "$MUTTJUMP_SCREEN_SESSION" ] ; then
171         screen_opts=("-S" "$MUTTJUMP_SCREEN_SESSION")
172         screen_opts_str="-S $(quote "$MUTTJUMP_SCREEN_SESSION")"
173     fi
174
175     $SCREEN "${screen_opts[@]}" -p "$screen_window_name" -X eval "select '$screen_window_name'" "stuff \"$jump_cmd\""
176
177     if [ $? != 0 ] ; then
178         die "You have to manually start a screen session with:
179 $SCREEN $screen_opts_str -t $(quote "$screen_window_name") $MUTT -f $(quote "$orig_maildir")"
180     fi
181 fi

Benjamin Mako Hill || Want to submit a patch?