if your connection is too slow, this won't be very pleasant to use,
and certainly won't seem transparent.)
-##Write a simple wrapper shell script##
-Now we will need to write a simple shell script that replaces the
-call to the notmuch binary with a call to notmuch over ssh.
+##Write a wrapper shell script##
-Note that this shell script also pauses briefly after every ten search
+/!\ Now that notmuch (>=0.5) allows for "raw" downloading of messages, a lot
+of the hacks in the older script, posted in 2010, are no longer necessary.
+
+Now we will need to write a simple shell script that does two things:
+
+1. replaces the call to the notmuch binary with a call to notmuch
+over ssh.
+2. caches messages when the entire raw message is downloaded. This
+avoids the need to constantly download large attachments over and
+over. (NB: this just checks to see if a message with the same id
+has already been cached. If you delete an attachment on the server,
+that could lead to an out-of-date cache. It would probably make more
+sense in the future to concatenate a hash of the message id and a hash
+of the message.)
+
+Note that this shell script also pauses briefly after every message
entries. This is currently necessary so that the emacs process-filter
doesn't chop off messages. It's an obvious hack, and hopefully won't
be necessary in the furture.
#!/usr/bin/env bash
-
SSH_BIN="/path/to/ssh/on/client"
USER="user_name"
- HOST="server_name"
+ SSH_HOST="server_name"
NOTMUCH_REMOTE_BIN="/path/to/notmuch/on/server"
+ CACHE="${HOME}/.notmuch-cache.d"
+
+ hash_name ()
+ {
+ echo -n ${1} | sha1sum | awk '{print $1}'
+ }
+
+ check_for_file_name ()
+ {
+ [ -f "${CACHE}/${1}" ]
+ }
- if [ $1 = "search" ]; then
- COUNT=0;
- OUT=`$SSH_BIN $USER@$HOST $NOTMUCH_REMOTE_BIN $@`
- echo "$OUT" | while read line; do
- COUNT=`expr $COUNT + 1`
- echo "$line";
- if [ $COUNT = 10 ]; then
- sleep 0.1;
- fi
+ notmuch_run ()
+ {
+ [ -d "${CACHE}" ] || mkdir -p "${CACHE}"
+ CMD=$1
+ shift
+ # we need to a little sanitizing of msg ids so the shell
+ # doesn't mangle them
+ ARGS=`echo $@ | sed 's/\\$/\\\\$/g'`
+ $SSH_BIN $USER@$SSH_HOST $NOTMUCH_REMOTE_BIN ${CMD} ${ARGS}
+ }
+
+ notmuch_search ()
+ {
+ #COUNTER=1
+ notmuch_run search $@ |
+ while read line; do
+ sleep 0.02
+ #[ $((COUNTER % 3)) == "0" ] && sleep 0.03
+ echo "${line}"
+ #COUNTER=$((COUNTER + 1))
done
+ }
+
+
+ notmuch_show ()
+ {
+ if [ ${1} = "--format=raw" ]; then
+ hashed=`hash_name ${2}`
+ check_for_file_name ${hashed} ||
+ notmuch_run show --format=raw ${2} > "${CACHE}/${hashed}"
+ cat "${CACHE}/${hashed}"
+ else
+ notmuch_run show $@
+ fi
+ }
+
+
+ if [ ${1} = "search" ]; then
+ shift
+ notmuch_search $@
+ elif [ ${1} = "show" ]; then
+ shift
+ notmuch_show $@
else
- $SSH_BIN $USER@$HOST $NOTMUCH_REMOTE_BIN $@
+ notmuch_run $@
fi
+
Save this to a file, "remote-notmuch.sh", in your path.
Now you can run "remote-notmuch.sh new". You can call the script
-anything you like. If you don't have a notmuch instance on your client
-computer, you can even call it "notmuch" and have totally transparent
+anything you like. I actually have $HOME/bin/notmuch linked to that
+script, so I can transparent
usage. (Since I run "new" from an emacs keybinding, I've never
bothered with this renaming.)
##Configure your emacs client##
-Add the following to your .emacs (this is on your client machine):
+The only thing you need to do is tell your emacs client to use the
+script. Add the following to your .emacs (this is on your client
+machine):
(setq notmuch-command "/path/to/your/remote-notmuch.sh")
-At least until 0.3 or 0.4, you will also need to add the following. It
-should become unnecessary pretty soon though:
-
- (setq notmuch-remote-host "user_name@server_name")
-
- (defadvice notmuch-show-get-filename (around
- notmuch-show-get-remote-filename
- activate)
- (setq ad-return-value (concat "/ssh:"
- notmuch-remote-host
- ":"
- ad-do-it)))
-
-The purpose of these lines is to allow emacs to have access to the raw
-files, via TRAMP, so that it can extract attachments and parse
-HTML. Work is afoot to make notmuch handle these tasks itself, so this
-part should soon be unecessary.
##A tip to speed things up##
If you have openssh >= 0.4, you can make use of the "ControlMaster"
using this approach and run into any problems, please feel free to
list them here. And, of course, if you improve on any of these
approaches, please do edit this page and let people know!
-
-
-
-
-
-
-
-
-
-
-
-
projects / notmuch-wiki / blobdiff