unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
* [Stefano Zacchiroli] Bug#628018: [PATCH] mutt-notmuch in notmuch contrib
@ 2012-03-26 10:32 David Bremner
  2012-03-26 10:37 ` [Stefano Zacchiroli] Bug#628018: [PATCH] notmuch-mutt utility for notmuch/contrib/ David Bremner
  0 siblings, 1 reply; 8+ messages in thread
From: David Bremner @ 2012-03-26 10:32 UTC (permalink / raw)
  To: notmuch; +Cc: Stefano Zacchiroli

[-- Attachment #1: Type: text/plain, Size: 160 bytes --]


Hi, this will probably eventually make it to the list, but until then,
here is a forwarded version. Please keep Stefano in CC, I don't think he's
subscribed.


[-- Attachment #2: Type: message/rfc822, Size: 25657 bytes --]

[-- Attachment #2.1.1.1: Type: text/plain, Size: 1598 bytes --]

[ please Cc:-me on follow-ups, as I'm not subscribed to the
  notmuch@notmuchmail.org mailing list ]

On Sun, Mar 25, 2012 at 10:13:38AM -0300, David Bremner wrote:
> In the mean time, we at least have a contrib directory, and I think
> mutt-notmuch would be welcome there. Could you (or somebody) make a
> reasonable size patch series that adds it to contrib/mutt-notmuch
> against current master. The patch series should be sent to the
> upstream mailing list notmuch@notmuchmail.org for review.

Hi David, thanks for the tip.

Dear notmuch list, please find attached a proposed patch that add a new
contrib utility called mutt-notmuch for integration with Mutt. Its full
rationale can be found in the contained README. Background for this
submission, including previous discussions to ship mutt-notmuch as part
of notmuch, can be found at
http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=628018

I welcome your comments on how to adapt the patch to your preferences
for contrib/, err, contributions.

> On the debian side your patch series could also include the necessary
> changes to make a new binary package.

I'll be pleased to do so when/if mutt-notmuch is accepted in contrib/,
just out of general laziness for potentially useless work :-)

Thanks,
Cheers.
-- 
Stefano Zacchiroli     zack@{upsilon.cc,pps.jussieu.fr,debian.org} . o .
Maître de conférences   ......   http://upsilon.cc/zack   ......   . . o
Debian Project Leader    .......   @zack on identi.ca   .......    o o o
« the first rule of tautology club is the first rule of tautology club »

[-- Attachment #2.1.1.2: 0001-contrib-new-utility-mutt-notmuch-for-Mutt-integratio.patch --]
[-- Type: text/x-diff, Size: 18383 bytes --]

From 8f5be32912920c2c5eca7084885c0e2498540311 Mon Sep 17 00:00:00 2001
From: Stefano Zacchiroli <zack@upsilon.cc>
Date: Sun, 25 Mar 2012 15:55:44 +0200
Subject: [PATCH] contrib: new utility mutt-notmuch for Mutt integration

---
 contrib/mutt-notmuch/Makefile       |   12 ++
 contrib/mutt-notmuch/README         |   58 +++++++++
 contrib/mutt-notmuch/mutt-notmuch   |  234 +++++++++++++++++++++++++++++++++++
 contrib/mutt-notmuch/mutt-notmuch.1 |  210 +++++++++++++++++++++++++++++++
 4 files changed, 514 insertions(+), 0 deletions(-)
 create mode 100644 contrib/mutt-notmuch/Makefile
 create mode 100644 contrib/mutt-notmuch/README
 create mode 100755 contrib/mutt-notmuch/mutt-notmuch
 create mode 100644 contrib/mutt-notmuch/mutt-notmuch.1

diff --git a/contrib/mutt-notmuch/Makefile b/contrib/mutt-notmuch/Makefile
new file mode 100644
index 0000000..b78953d
--- /dev/null
+++ b/contrib/mutt-notmuch/Makefile
@@ -0,0 +1,12 @@
+NAME = mutt-notmuch
+
+all: $(NAME) $(NAME).1
+
+$(NAME).1: $(NAME)
+	pod2man $< > $@
+
+README.html: README
+	markdown $< > $@
+
+clean:
+	rm -f mutt-notmuch.1 README.html
diff --git a/contrib/mutt-notmuch/README b/contrib/mutt-notmuch/README
new file mode 100644
index 0000000..e72aa91
--- /dev/null
+++ b/contrib/mutt-notmuch/README
@@ -0,0 +1,58 @@
+mutt-notmuch: Notmuch (of a) helper for Mutt
+============================================
+
+mutt-notmuch provide integration among the [Mutt] [1] mail user agent and the
+[Notmuch] [2] mail indexer.
+
+mutt-notmuch offer two basic integration features. The first one is the ability
+of stating a **search query interactively** and then jump to a fresh Maildir
+containing its search results only. The second one is the ability to
+**reconstruct threads on the fly** starting from the currently highlighted
+mail, which comes handy when a thread has been split across different maildirs,
+archived, or the like.
+
+mutt-notmuch enables to trigger mail searches via a Mutt macro (F8 being my
+choice) and reconstruct threads via another (F9). Check the manpage for the
+2-liner configuration snippet for your ~/.muttrc.
+
+A [blog style introduction] [3] to mutt-notmuch is available and includes some
+more rationale for its existence.
+
+Arguably, some of the logics of mutt-notmuch could disappear by adding support
+for a --output=symlinks flag to notmuch.
+
+
+[1]: http://www.mutt.org/
+[2]: http://notmuchmail.org/
+[3]: http://upsilon.cc/~zack/blog/posts/2011/01/how_to_use_Notmuch_with_Mutt/
+
+
+Requirements
+------------
+
+To *run* mutt-notmuch you will need Perl with the following libraries:
+
+- Mail::Box <http://search.cpan.org/~markov/Mail-Box/>
+  (Debian package: libmail-box-perl)
+- Mail::Internet <http://search.cpan.org/~markov/MailTools/>
+  (Debian package: libmailtools-perl)
+- String::ShellQuote <http://search.cpan.org/~rosch/String-ShellQuote/ShellQuote.pm>
+  (Debian package: libstring-shellquote-perl)
+- Term::ReadLine <http://search.cpan.org/~hayashi/Term-ReadLine-Gnu/>
+  (Debian package: libterm-readline-gnu-perl)
+
+To *build* mutt-notmuch documentation you will need:
+
+- pod2man (coming with Perl) to generate the manpage
+- markdown to generate README.html out of this file
+
+
+License
+-------
+
+mutt-notmuch is copyright (C) 2011-2012 Stefano Zacchiroli <zack@upsilon.cc>.
+
+mutt-notmuch is released under the terms of the GNU General Public License
+(GPL), version 3 or above. A copy of the license is available online at
+<http://www.gnu.org/licenses/>.
+
diff --git a/contrib/mutt-notmuch/mutt-notmuch b/contrib/mutt-notmuch/mutt-notmuch
new file mode 100755
index 0000000..31cb539
--- /dev/null
+++ b/contrib/mutt-notmuch/mutt-notmuch
@@ -0,0 +1,234 @@
+#!/usr/bin/perl -w
+#
+# mutt-notmuch - notmuch (of a) helper for Mutt
+#
+# Copyright: © 2011-2012 Stefano Zacchiroli <zack@upsilon.cc> 
+# License: GNU General Public License (GPL), version 3 or above
+#
+# See the bottom of this file for more documentation.
+# A manpage can be obtained by running "pod2man mutt-notmuch > mutt-notmuch.1"
+
+use strict;
+use warnings;
+
+use File::Path;
+use Getopt::Long qw(:config no_getopt_compat);
+use Mail::Internet;
+use Mail::Box::Maildir;
+use Pod::Usage;
+use String::ShellQuote;
+use Term::ReadLine;
+
+
+# create an empty maildir (if missing) or empty an existing maildir"
+sub empty_maildir($) {
+    my ($maildir) = (@_);
+    rmtree($maildir) if (-d $maildir);
+    my $folder = new Mail::Box::Maildir(folder => $maildir,
+					create => 1);
+    $folder->close();
+}
+
+# search($maildir, $query)
+# search mails according to $query with notmuch; store results in $maildir
+sub search($$) {
+    my ($maildir, $query) = @_;
+    $query = shell_quote($query);
+
+    empty_maildir($maildir);
+    system("notmuch search --output=files $query"
+	   . " | sed -e 's: :\\\\ :g'"
+	   . " | xargs --no-run-if-empty ln -s -t $maildir/cur/");
+}
+
+sub prompt($$) {
+    my ($text, $default) = @_;
+    my $query = "";
+    my $term = Term::ReadLine->new( "mutt-notmuch" );
+    $term->ornaments( 0 );
+    $term->unbind_key( ord( "\t" ) );
+    $term->MinLine( 3 );
+    if ($ENV{MUTT_NOTMUCH_HISTFILE} && -r "$ENV{MUTT_NOTMUCH_HISTFILE}") {
+      $term->ReadHistory("$ENV{MUTT_NOTMUCH_HISTFILE}");
+    } elsif (-r "$ENV{HOME}/.mutt-notmuch.history") {
+      $term->ReadHistory("$ENV{HOME}/.mutt-notmuch.history");
+    }
+    while (1) {
+	chomp($query = $term->readline($text, $default));
+	if ($query eq "?") {
+	    system("man", "notmuch");
+	} else {
+       if (!$ENV{MUTT_NOTMUCH_HISTFILE} ||
+           !$term->WriteHistory("$ENV{MUTT_NOTMUCH_HISTFILE}")) {
+         $term->WriteHistory("$ENV{HOME}/.mutt-notmuch.history");
+       }
+	    return $query;
+	}
+    }
+}
+
+sub get_message_id() {
+    my $mail = Mail::Internet->new(\*STDIN);
+    $mail->head->get("message-id") =~ /^<(.*)>$/;	# get message-id
+    return $1;
+}
+
+sub search_action($$@) {
+    my ($interactive, $results_dir, @params) = @_;
+
+    if (! $interactive) {
+	search($results_dir, join(' ', @params));
+    } else {
+	my $query = prompt("search ('?' for man): ", join(' ', @params));
+	if ($query ne "") {
+	    search($results_dir,$query);
+	}
+    }
+}
+
+sub thread_action(@) {
+    my ($results_dir, @params) = @_;
+    my $mid = get_message_id();
+    my $tid = `notmuch search --output=threads id:$mid`;# get thread id
+    chomp($tid);
+
+    search($results_dir, $tid);
+}
+
+sub tag_action(@) {
+    my $mid = get_message_id();
+
+    system("notmuch tag "
+	   . shell_quote(join(' ', @_))
+	   . " id:$mid");
+}
+
+sub die_usage() {
+    my %podflags = ( "verbose" => 1,
+		    "exitval" => 2 );
+    pod2usage(%podflags);
+}
+
+sub main() {
+    my $results_dir = "$ENV{HOME}/.cache/mutt_results";
+    my $interactive = 0;
+    my $help_needed = 0;
+
+    my $getopt = GetOptions(
+	"h|help" => \$help_needed,
+	"o|output-dir=s" => \$results_dir,
+	"p|prompt" => \$interactive);
+    if (! $getopt || $#ARGV < 0) { die_usage() };
+    my ($action, @params) = ($ARGV[0], @ARGV[1..$#ARGV]);
+
+    foreach my $param (@params) {
+      $param =~ s/folder:=/folder:/g;
+    }
+
+    if ($help_needed) {
+	die_usage();
+    } elsif ($action eq "search" && $#ARGV == 0 && ! $interactive) {
+	print STDERR "Error: no search term provided\n\n";
+	die_usage();
+    } elsif ($action eq "search") {
+	search_action($interactive, $results_dir, @params);
+    } elsif ($action eq "thread") {
+	thread_action($results_dir, @params);
+    } elsif ($action eq "tag") {
+	tag_action(@params);
+    } else {
+	die_usage();
+    }
+}
+
+main();
+
+__END__
+
+=head1 NAME
+
+mutt-notmuch - notmuch (of a) helper for Mutt
+
+=head1 SYNOPSIS
+
+=over
+
+=item B<mutt-notmuch> [I<OPTION>]... search [I<SEARCH-TERM>]...
+
+=item B<mutt-notmuch> [I<OPTION>]... thread < I<MAIL>
+
+=item B<mutt-notmuch> [I<OPTION>]... tag [I<TAGS>]... < I<MAIL>
+
+=back
+
+=head1 DESCRIPTION
+
+mutt-notmuch is a frontend to the notmuch mail indexer capable of populating
+maildir with search results.
+
+=head1 OPTIONS
+
+=over 4
+
+=item -o DIR
+
+=item --output-dir DIR
+
+Store search results as (symlink) messages under maildir DIR. Beware: DIR will
+be overwritten. (Default: F<~/.cache/mutt_results/>)
+
+=item -p
+
+=item --prompt
+
+Instead of using command line search terms, prompt the user for them (only for
+"search").
+
+=item -h
+
+=item --help
+
+Show usage information and exit.
+
+=back
+
+=head1 INTEGRATION WITH MUTT
+
+mutt-notmuch can be used to integrate notmuch with the Mutt mail user agent
+(unsurprisingly, given the name). To that end, you should define the following
+macros in your F<~/.muttrc> (replacing F<~/bin/mutt-notmuch> for the actual
+location of mutt-notmuch on your system):
+
+    macro index <F8> \
+          "<enter-command>unset wait_key<enter><shell-escape>~/bin/mutt-notmuch --prompt search<enter><change-folder-readonly>~/.cache/mutt_results<enter>" \
+          "search mail (using notmuch)"
+    macro index <F9> \
+          "<enter-command>unset wait_key<enter><pipe-message>~/bin/mutt-notmuch thread<enter><change-folder-readonly>~/.cache/mutt_results<enter><enter-command>set wait_key<enter>" \
+          "search and reconstruct owning thread (using notmuch)"
+    macro index <F6> \
+          "<enter-command>unset wait_key<enter><pipe-message>~/bin/mutt-notmuch tag -inbox<enter>" \
+          "remove message from inbox (using notmuch)"
+
+The first macro (activated by <F8>) will prompt the user for notmuch search
+terms and then jump to a temporary maildir showing search results. The second
+macro (activated by <F9>) will reconstruct the thread corresponding to the
+current mail and show it as search results. The third macro (activated by <F6>)
+removes the tag C<inbox> from the current message; by changing C<-inbox> this
+macro may be customised to add or remove tags appropriate to the users notmuch
+work-flow.
+
+To keep notmuch index current you should then periodically run C<notmuch
+new>. Depending on your local mail setup, you might want to do that via cron,
+as a hook triggered by mail retrieval, etc.
+
+=head1 SEE ALSO
+
+mutt(1), notmuch(1)
+
+=head1 AUTHOR
+
+Copyright: (C) 2011-2012 Stefano Zacchiroli <zack@upsilon.cc>
+
+License: GNU General Public License (GPL), version 3 or higher
+
+=cut
diff --git a/contrib/mutt-notmuch/mutt-notmuch.1 b/contrib/mutt-notmuch/mutt-notmuch.1
new file mode 100644
index 0000000..fe5e653
--- /dev/null
+++ b/contrib/mutt-notmuch/mutt-notmuch.1
@@ -0,0 +1,210 @@
+.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.ie \nF \{\
+.    de IX
+.    tm Index:\\$1\t\\n%\t"\\$2"
+..
+.    nr % 0
+.    rr F
+.\}
+.el \{\
+.    de IX
+..
+.\}
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "MUTT-NOTMUCH 1"
+.TH MUTT-NOTMUCH 1 "2012-03-25" "perl v5.14.2" "User Contributed Perl Documentation"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+mutt\-notmuch \- notmuch (of a) helper for Mutt
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.IP "\fBmutt-notmuch\fR [\fI\s-1OPTION\s0\fR]... search [\fISEARCH-TERM\fR]..." 4
+.IX Item "mutt-notmuch [OPTION]... search [SEARCH-TERM]..."
+.PD 0
+.IP "\fBmutt-notmuch\fR [\fI\s-1OPTION\s0\fR]... thread < \fI\s-1MAIL\s0\fR" 4
+.IX Item "mutt-notmuch [OPTION]... thread < MAIL"
+.IP "\fBmutt-notmuch\fR [\fI\s-1OPTION\s0\fR]... tag [\fI\s-1TAGS\s0\fR]... < \fI\s-1MAIL\s0\fR" 4
+.IX Item "mutt-notmuch [OPTION]... tag [TAGS]... < MAIL"
+.PD
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+mutt-notmuch is a frontend to the notmuch mail indexer capable of populating
+maildir with search results.
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.IP "\-o \s-1DIR\s0" 4
+.IX Item "-o DIR"
+.PD 0
+.IP "\-\-output\-dir \s-1DIR\s0" 4
+.IX Item "--output-dir DIR"
+.PD
+Store search results as (symlink) messages under maildir \s-1DIR\s0. Beware: \s-1DIR\s0 will
+be overwritten. (Default: \fI~/.cache/mutt_results/\fR)
+.IP "\-p" 4
+.IX Item "-p"
+.PD 0
+.IP "\-\-prompt" 4
+.IX Item "--prompt"
+.PD
+Instead of using command line search terms, prompt the user for them (only for
+\&\*(L"search\*(R").
+.IP "\-h" 4
+.IX Item "-h"
+.PD 0
+.IP "\-\-help" 4
+.IX Item "--help"
+.PD
+Show usage information and exit.
+.SH "INTEGRATION WITH MUTT"
+.IX Header "INTEGRATION WITH MUTT"
+mutt-notmuch can be used to integrate notmuch with the Mutt mail user agent
+(unsurprisingly, given the name). To that end, you should define the following
+macros in your \fI~/.muttrc\fR (replacing \fI~/bin/mutt\-notmuch\fR for the actual
+location of mutt-notmuch on your system):
+.PP
+.Vb 9
+\&    macro index <F8> \e
+\&          "<enter\-command>unset wait_key<enter><shell\-escape>~/bin/mutt\-notmuch \-\-prompt search<enter><change\-folder\-readonly>~/.cache/mutt_results<enter>" \e
+\&          "search mail (using notmuch)"
+\&    macro index <F9> \e
+\&          "<enter\-command>unset wait_key<enter><pipe\-message>~/bin/mutt\-notmuch thread<enter><change\-folder\-readonly>~/.cache/mutt_results<enter><enter\-command>set wait_key<enter>" \e
+\&          "search and reconstruct owning thread (using notmuch)"
+\&    macro index <F6> \e
+\&          "<enter\-command>unset wait_key<enter><pipe\-message>~/bin/mutt\-notmuch tag \-inbox<enter>" \e
+\&          "remove message from inbox (using notmuch)"
+.Ve
+.PP
+The first macro (activated by <F8>) will prompt the user for notmuch search
+terms and then jump to a temporary maildir showing search results. The second
+macro (activated by <F9>) will reconstruct the thread corresponding to the
+current mail and show it as search results. The third macro (activated by <F6>)
+removes the tag \f(CW\*(C`inbox\*(C'\fR from the current message; by changing \f(CW\*(C`\-inbox\*(C'\fR this
+macro may be customised to add or remove tags appropriate to the users notmuch
+work-flow.
+.PP
+To keep notmuch index current you should then periodically run \f(CW\*(C`notmuch
+new\*(C'\fR. Depending on your local mail setup, you might want to do that via cron,
+as a hook triggered by mail retrieval, etc.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fImutt\fR\|(1), \fInotmuch\fR\|(1)
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Copyright: (C) 2011\-2012 Stefano Zacchiroli <zack@upsilon.cc>
+.PP
+License: \s-1GNU\s0 General Public License (\s-1GPL\s0), version 3 or higher
-- 
1.7.9.1


[-- Attachment #2.1.2: Digital signature --]
[-- Type: application/pgp-signature, Size: 828 bytes --]

^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [Stefano Zacchiroli] Bug#628018: [PATCH] notmuch-mutt utility for notmuch/contrib/
  2012-03-26 10:32 [Stefano Zacchiroli] Bug#628018: [PATCH] mutt-notmuch in notmuch contrib David Bremner
@ 2012-03-26 10:37 ` David Bremner
  2012-03-26 12:34   ` Tomi Ollila
  0 siblings, 1 reply; 8+ messages in thread
From: David Bremner @ 2012-03-26 10:37 UTC (permalink / raw)
  To: notmuch


[-- Attachment #0: Type: message/rfc822, Size: 21666 bytes --]

[-- Attachment #1.1.1: Type: text/plain, Size: 1114 bytes --]

Here is an updated patch set that ships the notmuch-mutt utility and
updated the Debian packaging for it. It is now better integrated with
notmuch: it has been renamed to "notmuch-mutt" (to match the naming
convention of other notmuch interfaces) and stores all its data under
~/.cache/notmuch/mutt/ to avoid polluting user $HOME with other
directories. I've also fixed the Debian packaging to generate the
manpage during build.

The first patch in the set adds notmuch-mutt to contrib/, the second
updates debian/ to build a new "notmuch-mutt" binary package.

The full story is available at http://bugs.debian.org/628018

David: I'm still unable to get through the moderation queue of the
notmuch mailing list. Would you be so kind to forward this mail there,
for patch review?

TIA,
Cheers.
-- 
Stefano Zacchiroli     zack@{upsilon.cc,pps.jussieu.fr,debian.org} . o .
Maître de conférences   ......   http://upsilon.cc/zack   ......   . . o
Debian Project Leader    .......   @zack on identi.ca   .......    o o o
« the first rule of tautology club is the first rule of tautology club »

[-- Attachment #1.1.2: 0001-contrib-new-mutt-notmuch-utility-for-Mutt-integratio.patch --]
[-- Type: text/x-diff, Size: 11683 bytes --]

From cbb43be7d163e7662c0aa4fcb69f173074bb947d Mon Sep 17 00:00:00 2001
From: Stefano Zacchiroli <zack@upsilon.cc>
Date: Mon, 26 Mar 2012 10:45:58 +0200
Subject: [PATCH 1/2] contrib: new mutt-notmuch utility for Mutt integration

---
 contrib/notmuch-mutt/.gitignore      |    2 +
 contrib/notmuch-mutt/Makefile        |   12 ++
 contrib/notmuch-mutt/README          |   59 +++++++++
 contrib/notmuch-mutt/notmuch-mutt    |  234 ++++++++++++++++++++++++++++++++++
 contrib/notmuch-mutt/notmuch-mutt.rc |    9 ++
 5 files changed, 316 insertions(+), 0 deletions(-)
 create mode 100644 contrib/notmuch-mutt/.gitignore
 create mode 100644 contrib/notmuch-mutt/Makefile
 create mode 100644 contrib/notmuch-mutt/README
 create mode 100755 contrib/notmuch-mutt/notmuch-mutt
 create mode 100644 contrib/notmuch-mutt/notmuch-mutt.rc

diff --git a/contrib/notmuch-mutt/.gitignore b/contrib/notmuch-mutt/.gitignore
new file mode 100644
index 0000000..682a577
--- /dev/null
+++ b/contrib/notmuch-mutt/.gitignore
@@ -0,0 +1,2 @@
+notmuch-mutt.1
+README.html
diff --git a/contrib/notmuch-mutt/Makefile b/contrib/notmuch-mutt/Makefile
new file mode 100644
index 0000000..87f9031
--- /dev/null
+++ b/contrib/notmuch-mutt/Makefile
@@ -0,0 +1,12 @@
+NAME = notmuch-mutt
+
+all: $(NAME) $(NAME).1
+
+$(NAME).1: $(NAME)
+	pod2man $< > $@
+
+README.html: README
+	markdown $< > $@
+
+clean:
+	rm -f notmuch-mutt.1 README.html
diff --git a/contrib/notmuch-mutt/README b/contrib/notmuch-mutt/README
new file mode 100644
index 0000000..382ac91
--- /dev/null
+++ b/contrib/notmuch-mutt/README
@@ -0,0 +1,59 @@
+notmuch-mutt: Notmuch (of a) helper for Mutt
+============================================
+
+notmuch-mutt provide integration among the [Mutt] [1] mail user agent and the
+[Notmuch] [2] mail indexer.
+
+notmuch-mutt offer two main integration features. The first one is the ability
+of stating a **search query interactively** and then jump to a fresh Maildir
+containing its search results only. The second one is the ability to
+**reconstruct threads on the fly** starting from the currently highlighted
+mail, which comes handy when a thread has been split across different maildirs,
+archived, or the like.
+
+notmuch-mutt enables to trigger mail searches via a Mutt macro (usually F8) and
+reconstruct threads via another (usually F9). Check the manpage for the 2-liner
+configuration snippet for your Mutt configuration files (~/.muttrc,
+/etc/Muttrc, or a /etc/Muttrc.d snippet).
+
+A [blog style introduction] [3] to notmuch-mutt is available and includes some
+more rationale for its existence.
+
+Arguably, some of the logics of notmuch-mutt could disappear by adding support
+for a --output=symlinks flag to notmuch.
+
+
+[1]: http://www.mutt.org/
+[2]: http://notmuchmail.org/
+[3]: http://upsilon.cc/~zack/blog/posts/2011/01/how_to_use_Notmuch_with_Mutt/
+
+
+Requirements
+------------
+
+To *run* notmuch-mutt you will need Perl with the following libraries:
+
+- Mail::Box <http://search.cpan.org/~markov/Mail-Box/>
+  (Debian package: libmail-box-perl)
+- Mail::Internet <http://search.cpan.org/~markov/MailTools/>
+  (Debian package: libmailtools-perl)
+- String::ShellQuote <http://search.cpan.org/~rosch/String-ShellQuote/ShellQuote.pm>
+  (Debian package: libstring-shellquote-perl)
+- Term::ReadLine <http://search.cpan.org/~hayashi/Term-ReadLine-Gnu/>
+  (Debian package: libterm-readline-gnu-perl)
+
+To *build* notmuch-mutt documentation you will need:
+
+- pod2man (coming with Perl) to generate the manpage
+- markdown to generate README.html out of this file
+
+
+License
+-------
+
+notmuch-mutt is copyright (C) 2011-2012 Stefano Zacchiroli <zack@upsilon.cc>.
+
+notmuch-mutt is released under the terms of the GNU General Public License
+(GPL), version 3 or above. A copy of the license is available online at
+<http://www.gnu.org/licenses/>.
+
diff --git a/contrib/notmuch-mutt/notmuch-mutt b/contrib/notmuch-mutt/notmuch-mutt
new file mode 100755
index 0000000..29674ec
--- /dev/null
+++ b/contrib/notmuch-mutt/notmuch-mutt
@@ -0,0 +1,234 @@
+#!/usr/bin/perl -w
+#
+# notmuch-mutt - notmuch (of a) helper for Mutt
+#
+# Copyright: © 2011-2012 Stefano Zacchiroli <zack@upsilon.cc> 
+# License: GNU General Public License (GPL), version 3 or above
+#
+# See the bottom of this file for more documentation.
+# A manpage can be obtained by running "pod2man notmuch-mutt > notmuch-mutt.1"
+
+use strict;
+use warnings;
+
+use File::Path;
+use Getopt::Long qw(:config no_getopt_compat);
+use Mail::Internet;
+use Mail::Box::Maildir;
+use Pod::Usage;
+use String::ShellQuote;
+use Term::ReadLine;
+
+
+my $cache_dir = "$ENV{HOME}/.cache/notmuch/mutt";
+
+
+# create an empty maildir (if missing) or empty an existing maildir"
+sub empty_maildir($) {
+    my ($maildir) = (@_);
+    rmtree($maildir) if (-d $maildir);
+    my $folder = new Mail::Box::Maildir(folder => $maildir,
+					create => 1);
+    $folder->close();
+}
+
+# search($maildir, $query)
+# search mails according to $query with notmuch; store results in $maildir
+sub search($$) {
+    my ($maildir, $query) = @_;
+    $query = shell_quote($query);
+
+    empty_maildir($maildir);
+    system("notmuch search --output=files $query"
+	   . " | sed -e 's: :\\\\ :g'"
+	   . " | xargs --no-run-if-empty ln -s -t $maildir/cur/");
+}
+
+sub prompt($$) {
+    my ($text, $default) = @_;
+    my $query = "";
+    my $term = Term::ReadLine->new( "notmuch-mutt" );
+    my $histfile = "$cache_dir/history";
+
+    $term->ornaments( 0 );
+    $term->unbind_key( ord( "\t" ) );
+    $term->MinLine( 3 );
+    $histfile = $ENV{MUTT_NOTMUCH_HISTFILE} if $ENV{MUTT_NOTMUCH_HISTFILE};
+    $term->ReadHistory($histfile) if (-r $histfile);
+    while (1) {
+	chomp($query = $term->readline($text, $default));
+	if ($query eq "?") {
+	    system("man", "notmuch");
+	} else {
+	    $term->WriteHistory($histfile);
+	    return $query;
+	}
+    }
+}
+
+sub get_message_id() {
+    my $mail = Mail::Internet->new(\*STDIN);
+    $mail->head->get("message-id") =~ /^<(.*)>$/;	# get message-id
+    return $1;
+}
+
+sub search_action($$@) {
+    my ($interactive, $results_dir, @params) = @_;
+
+    if (! $interactive) {
+	search($results_dir, join(' ', @params));
+    } else {
+	my $query = prompt("search ('?' for man): ", join(' ', @params));
+	if ($query ne "") {
+	    search($results_dir,$query);
+	}
+    }
+}
+
+sub thread_action(@) {
+    my ($results_dir, @params) = @_;
+    my $mid = get_message_id();
+    my $tid = `notmuch search --output=threads id:$mid`;# get thread id
+    chomp($tid);
+
+    search($results_dir, $tid);
+}
+
+sub tag_action(@) {
+    my $mid = get_message_id();
+
+    system("notmuch tag "
+	   . shell_quote(join(' ', @_))
+	   . " id:$mid");
+}
+
+sub die_usage() {
+    my %podflags = ( "verbose" => 1,
+		    "exitval" => 2 );
+    pod2usage(%podflags);
+}
+
+sub main() {
+    mkpath($cache_dir) unless (-d $cache_dir);
+
+    my $results_dir = "$cache_dir/results";
+    my $interactive = 0;
+    my $help_needed = 0;
+
+    my $getopt = GetOptions(
+	"h|help" => \$help_needed,
+	"o|output-dir=s" => \$results_dir,
+	"p|prompt" => \$interactive);
+    if (! $getopt || $#ARGV < 0) { die_usage() };
+    my ($action, @params) = ($ARGV[0], @ARGV[1..$#ARGV]);
+
+    foreach my $param (@params) {
+      $param =~ s/folder:=/folder:/g;
+    }
+
+    if ($help_needed) {
+	die_usage();
+    } elsif ($action eq "search" && $#ARGV == 0 && ! $interactive) {
+	print STDERR "Error: no search term provided\n\n";
+	die_usage();
+    } elsif ($action eq "search") {
+	search_action($interactive, $results_dir, @params);
+    } elsif ($action eq "thread") {
+	thread_action($results_dir, @params);
+    } elsif ($action eq "tag") {
+	tag_action(@params);
+    } else {
+	die_usage();
+    }
+}
+
+main();
+
+__END__
+
+=head1 NAME
+
+notmuch-mutt - notmuch (of a) helper for Mutt
+
+=head1 SYNOPSIS
+
+=over
+
+=item B<notmuch-mutt> [I<OPTION>]... search [I<SEARCH-TERM>]...
+
+=item B<notmuch-mutt> [I<OPTION>]... thread < I<MAIL>
+
+=item B<notmuch-mutt> [I<OPTION>]... tag [I<TAGS>]... < I<MAIL>
+
+=back
+
+=head1 DESCRIPTION
+
+notmuch-mutt is a frontend to the notmuch mail indexer capable of populating
+maildir with search results.
+
+=head1 OPTIONS
+
+=over 4
+
+=item -o DIR
+
+=item --output-dir DIR
+
+Store search results as (symlink) messages under maildir DIR. Beware: DIR will
+be overwritten. (Default: F<~/.cache/notmuch/mutt/results/>)
+
+=item -p
+
+=item --prompt
+
+Instead of using command line search terms, prompt the user for them (only for
+"search").
+
+=item -h
+
+=item --help
+
+Show usage information and exit.
+
+=back
+
+=head1 INTEGRATION WITH MUTT
+
+notmuch-mutt can be used to integrate notmuch with the Mutt mail user agent
+(unsurprisingly, given the name). To that end, you should define macros like
+the following in your Mutt configuration (usually one of: F<~/.muttrc>,
+F</etc/Muttrc>, or a configuration snippet under F</etc/Muttrc.d/>):
+
+    macro index <F8> \
+          "<enter-command>unset wait_key<enter><shell-escape>notmuch-mutt --prompt search<enter><change-folder-readonly>~/.cache/notmuch/mutt/results<enter>" \
+          "notmuch: search mail"
+    macro index <F9> \
+          "<enter-command>unset wait_key<enter><pipe-message>notmuch-mutt thread<enter><change-folder-readonly>~/.cache/notmuch/mutt/results<enter><enter-command>set wait_key<enter>" \
+          "notmuch: reconstruct thread"
+    macro index <F6> \
+          "<enter-command>unset wait_key<enter><pipe-message>notmuch-mutt tag -inbox<enter>" \
+          "notmuch: remove message from inbox"
+
+The first macro (activated by <F8>) prompts the user for notmuch search terms
+and then jump to a temporary maildir showing search results. The second macro
+(activated by <F9>) reconstructs the thread corresponding to the current mail
+and show it as search results. The third macro (activated by <F6>) removes the
+tag C<inbox> from the current message; by changing C<-inbox> this macro may be
+customised to add or remove tags appropriate to the users notmuch work-flow.
+
+To keep notmuch index current you should then periodically run C<notmuch
+new>. Depending on your local mail setup, you might want to do that via cron,
+as a hook triggered by mail retrieval, etc.
+
+=head1 SEE ALSO
+
+mutt(1), notmuch(1)
+
+=head1 AUTHOR
+
+Copyright: (C) 2011-2012 Stefano Zacchiroli <zack@upsilon.cc>
+
+License: GNU General Public License (GPL), version 3 or higher
+
+=cut
diff --git a/contrib/notmuch-mutt/notmuch-mutt.rc b/contrib/notmuch-mutt/notmuch-mutt.rc
new file mode 100644
index 0000000..269f03f
--- /dev/null
+++ b/contrib/notmuch-mutt/notmuch-mutt.rc
@@ -0,0 +1,9 @@
+macro index <F8> \
+      "<enter-command>unset wait_key<enter><shell-escape>notmuch-mutt --prompt search<enter><change-folder-readonly>~/.cache/notmuch/mutt/results<enter>" \
+      "notmuch: search mail"
+macro index <F9> \
+      "<enter-command>unset wait_key<enter><pipe-message>notmuch-mutt thread<enter><change-folder-readonly>~/.cache/notmuch/mutt/results<enter><enter-command>set wait_key<enter>" \
+      "notmuch: reconstruct thread"
+macro index <F6> \
+      "<enter-command>unset wait_key<enter><pipe-message>notmuch-mutt tag -inbox<enter>" \
+      "notmuch: remove message from inbox"
-- 
1.7.9.1


[-- Attachment #1.1.3: 0002-debian-packaging-new-binary-package-notmuch-mutt.patch --]
[-- Type: text/x-diff, Size: 3313 bytes --]

From c342af0fa2b9d936753f57cd8fa232ca246079d1 Mon Sep 17 00:00:00 2001
From: Stefano Zacchiroli <zack@upsilon.cc>
Date: Mon, 26 Mar 2012 10:51:44 +0200
Subject: [PATCH 2/2] debian packaging: new binary package notmuch-mutt

---
 debian/changelog             |    6 ++++++
 debian/control               |   16 ++++++++++++++++
 debian/notmuch-mutt.docs     |    1 +
 debian/notmuch-mutt.install  |    2 ++
 debian/notmuch-mutt.manpages |    1 +
 debian/rules                 |    2 ++
 6 files changed, 28 insertions(+), 0 deletions(-)
 create mode 100644 debian/notmuch-mutt.docs
 create mode 100644 debian/notmuch-mutt.install
 create mode 100644 debian/notmuch-mutt.manpages

diff --git a/debian/changelog b/debian/changelog
index d0eec37..bd70d08 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+notmuch (0.12-2) UNRELEASED; urgency=low
+
+  * new binary package "notmuch-mutt" for Mutt integration
+
+ -- Stefano Zacchiroli <zack@debian.org>  Mon, 26 Mar 2012 10:47:29 +0200
+
 notmuch (0.12-1) unstable; urgency=low
 
   * New upstream release
diff --git a/debian/control b/debian/control
index ed27c58..ada9d3d 100644
--- a/debian/control
+++ b/debian/control
@@ -105,3 +105,19 @@ Description: thread-based email index, search and tagging (vim interface)
  This package provides a vim based mail user agent based on
  notmuch.
 
+Package: notmuch-mutt
+Architecture: all
+Depends: notmuch, libmail-box-perl, libmailtools-perl,
+ libstring-shellquote-perl, libterm-readline-gnu-perl,
+ ${misc:Depends}
+Recommends: mutt
+Enhances: notmuch, mutt
+Description: thread-based email index, search and tagging (Mutt interface)
+ notmuch-mutt provides integration among the Mutt mail user agent and
+ the Notmuch mail indexer.
+ .
+ notmuch-mutt offer two main integration features. The first one is
+ the ability of stating a search query interactively and then jump to
+ a fresh Maildir containing its search results only. The second one is
+ the ability to reconstruct threads on the fly starting from the
+ current highlighted mail.
diff --git a/debian/notmuch-mutt.docs b/debian/notmuch-mutt.docs
new file mode 100644
index 0000000..f3d25cd
--- /dev/null
+++ b/debian/notmuch-mutt.docs
@@ -0,0 +1 @@
+contrib/notmuch-mutt/README
diff --git a/debian/notmuch-mutt.install b/debian/notmuch-mutt.install
new file mode 100644
index 0000000..9141c26
--- /dev/null
+++ b/debian/notmuch-mutt.install
@@ -0,0 +1,2 @@
+contrib/notmuch-mutt/notmuch-mutt	usr/bin
+contrib/notmuch-mutt/notmuch-mutt.rc	etc/Muttrc.d
diff --git a/debian/notmuch-mutt.manpages b/debian/notmuch-mutt.manpages
new file mode 100644
index 0000000..3f6b8ab
--- /dev/null
+++ b/debian/notmuch-mutt.manpages
@@ -0,0 +1 @@
+contrib/notmuch-mutt/notmuch-mutt.1
diff --git a/debian/rules b/debian/rules
index 956f3f2..603b3ab 100755
--- a/debian/rules
+++ b/debian/rules
@@ -9,10 +9,12 @@ override_dh_auto_configure:
 override_dh_auto_build:
 	dh_auto_build
 	dh_auto_build --sourcedirectory bindings/python
+	$(MAKE) -C contrib/notmuch-mutt
 
 override_dh_auto_clean:
 	dh_auto_clean
 	dh_auto_clean --sourcedirectory bindings/python
+	$(MAKE) -C contrib/notmuch-mutt clean
 
 override_dh_auto_install:
 	dh_auto_install
-- 
1.7.9.1


[-- Attachment #1.2: Digital signature --]
[-- Type: application/pgp-signature, Size: 828 bytes --]

^ permalink raw reply related	[flat|nested] 8+ messages in thread

* Re: [Stefano Zacchiroli] Bug#628018: [PATCH] notmuch-mutt utility for notmuch/contrib/
  2012-03-26 10:37 ` [Stefano Zacchiroli] Bug#628018: [PATCH] notmuch-mutt utility for notmuch/contrib/ David Bremner
@ 2012-03-26 12:34   ` Tomi Ollila
  2012-03-26 15:09     ` Jameson Graef Rollins
  0 siblings, 1 reply; 8+ messages in thread
From: Tomi Ollila @ 2012-03-26 12:34 UTC (permalink / raw)
  To: zack; +Cc: notmuch


Interesting, 'R' in emacs gives empty content. I might have Austin's 
reply change in this version -- although I suspect the problem is not
there. Everyone using emacs MUA with latest notmuch(1)es experiment
pressing 'R' while reading the mail I'm replying to

Pasting content...

> [ multipart/mixed ]
> [ message/rfc822 ]
> From: Stefano Zacchiroli <zack@debian.org>
> Subject: Bug#628018: [PATCH] notmuch-mutt utility for notmuch/contrib/
> To: 628018@bugs.debian.org
> Date: Mon, 26 Mar 2012 11:36:06 +0200
>
> [ multipart/signed ]
> [ Good signature by key: 0x4900707DDC5C07F2DECB02839C31503C6D866396 ]
> [ multipart/mixed ]
> [ text/plain ]
> Here is an updated patch set that ships the notmuch-mutt utility and
> updated the Debian packaging for it. It is now better integrated with
> notmuch: it has been renamed to "notmuch-mutt" (to match the naming
> convention of other notmuch interfaces) and stores all its data under
> ~/.cache/notmuch/mutt/ to avoid polluting user $HOME with other
> directories. I've also fixed the Debian packaging to generate the
> manpage during build.

I think storing stuff to  .../.cache/... is Great !!!

However, if we're "allowing" public software to use .../.cache/notmuch
directory we should have policy to do so. I suggest we add a description
file to notmuch source distribution which describes the public software
that are allowed to contain files in notmuch XDG directories. The file
could have format which describes the file/directory name, the software
using it and some description why this file is there.

Another thing is this .cache hardcoding. Should this be resolved
first by using $XDG_CACHE_HOME, (then *MAYBE* $XDG_CONFIG_HOME/.cache)
and finally $HOME/.cache

Tomi


>
> The first patch in the set adds notmuch-mutt to contrib/, the second
> updates debian/ to build a new "notmuch-mutt" binary package.
>
> The full story is available at http://bugs.debian.org/628018
>
> David: I'm still unable to get through the moderation queue of the
> notmuch mailing list. Would you be so kind to forward this mail there,
> for patch review?
>
> TIA,
> Cheers.

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [Stefano Zacchiroli] Bug#628018: [PATCH] notmuch-mutt utility for notmuch/contrib/
  2012-03-26 12:34   ` Tomi Ollila
@ 2012-03-26 15:09     ` Jameson Graef Rollins
  2012-03-26 15:29       ` Stefano Zacchiroli
  0 siblings, 1 reply; 8+ messages in thread
From: Jameson Graef Rollins @ 2012-03-26 15:09 UTC (permalink / raw)
  To: Tomi Ollila, zack; +Cc: notmuch

[-- Attachment #1: Type: text/plain, Size: 1131 bytes --]

On Mon, 26 Mar 2012 15:34:04 +0300, Tomi Ollila <tomi.ollila@iki.fi> wrote:
> I think storing stuff to  .../.cache/... is Great !!!
> 
> However, if we're "allowing" public software to use .../.cache/notmuch
> directory we should have policy to do so. I suggest we add a description
> file to notmuch source distribution which describes the public software
> that are allowed to contain files in notmuch XDG directories. The file
> could have format which describes the file/directory name, the software
> using it and some description why this file is there.
> 
> Another thing is this .cache hardcoding. Should this be resolved
> first by using $XDG_CACHE_HOME, (then *MAYBE* $XDG_CONFIG_HOME/.cache)
> and finally $HOME/.cache

These are good points.  I agree that since ~/.cache is an XDG standard
we should resolve the appropriate environment variables.

If notmuch-mutt is accepted into notmuch upstream then it really becomes
a part of notmuch and isn't really "public" anymore (at least in the
sense that you're using).  So I don't really see any problem with having
it use ~/.cache/notmuch.

jamie.

[-- Attachment #2: Type: application/pgp-signature, Size: 835 bytes --]

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: Bug#628018: [PATCH] notmuch-mutt utility for notmuch/contrib/
  2012-03-26 15:09     ` Jameson Graef Rollins
@ 2012-03-26 15:29       ` Stefano Zacchiroli
  2012-03-26 18:52         ` Stefano Zacchiroli
  2012-03-26 19:03         ` Scott Barker
  0 siblings, 2 replies; 8+ messages in thread
From: Stefano Zacchiroli @ 2012-03-26 15:29 UTC (permalink / raw)
  To: notmuch

On Mon, Mar 26, 2012 at 08:09:13AM -0700, Jameson Graef Rollins wrote:
> > Another thing is this .cache hardcoding. Should this be resolved
> > first by using $XDG_CACHE_HOME, (then *MAYBE* $XDG_CONFIG_HOME/.cache)
> > and finally $HOME/.cache
> 
> These are good points.  I agree that since ~/.cache is an XDG standard
> we should resolve the appropriate environment variables.

Heya, thanks for your feedback. I agree as well!

But while it's trivial to make notmuch-mutt itself support
$XDG_CACHE_HOME, it is less so for the Mutt configuration snippet
(i.e. the notmuch-mutt.rc file which is part of my submission). AFAICT
the <change-folder-readonly> function does not support variable
expansions, not to mention default values while doing so. As a result, I
can easily support $XDG_CACHE_HOME for, say, the history file, but I
don't know how to make mutt look in some $XDG_CACHE_HOME derived
directory. (Yes, I'm excluding hackish solutions like have mutt look
always in the same dir, and make that dir a "moving" symlink that will
be changed by notmuch-mutt upon execution. That seems to defeat the
benefits of the XDG specification, at least partly.)

Bottom line: I'll be happy to properly support $XDG_CACHE_HOME, but I'm
in need on suggestions of how to do so for the Mutt configuration part.

> If notmuch-mutt is accepted into notmuch upstream then it really becomes
> a part of notmuch and isn't really "public" anymore (at least in the
> sense that you're using).  So I don't really see any problem with having
> it use ~/.cache/notmuch.

My thought exactly.

The proposal of documenting how people should use ~/.cache/notmuch is
great, but I was hoping it can be overlooked for contrib stuff that has
been vetted by you folks.

Thanks for your help (and for notmuch!)
Cheers.
-- 
Stefano Zacchiroli     zack@{upsilon.cc,pps.jussieu.fr,debian.org} . o .
Maître de conférences   ......   http://upsilon.cc/zack   ......   . . o
Debian Project Leader    .......   @zack on identi.ca   .......    o o o
« the first rule of tautology club is the first rule of tautology club »

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: Bug#628018: [PATCH] notmuch-mutt utility for notmuch/contrib/
  2012-03-26 15:29       ` Stefano Zacchiroli
@ 2012-03-26 18:52         ` Stefano Zacchiroli
  2012-03-26 19:03         ` Scott Barker
  1 sibling, 0 replies; 8+ messages in thread
From: Stefano Zacchiroli @ 2012-03-26 18:52 UTC (permalink / raw)
  To: notmuch


[-- Attachment #1.1: Type: text/plain, Size: 1163 bytes --]

On Mon, Mar 26, 2012 at 05:29:02PM +0200, Stefano Zacchiroli wrote:
> But while it's trivial to make notmuch-mutt itself support
> $XDG_CACHE_HOME, it is less so for the Mutt configuration snippet
> (i.e. the notmuch-mutt.rc file which is part of my submission). AFAICT
> the <change-folder-readonly> function does not support variable
> expansions, not to mention default values while doing so.

... but Mutt configuration has backtick expansions! So never mind the
above.

The attached patch should be all that's needed to proper $XDG_CACHE_HOME
support, according to XDG basedir spec.

If you folks now consider the contrib submission good enough for
inclusion, feel free to just "git am" the 3 patches. If you want me to
implement other changes --- including bureaucratic stuff like merging
patches together --- just let me know!

Cheers.
-- 
Stefano Zacchiroli     zack@{upsilon.cc,pps.jussieu.fr,debian.org} . o .
Maître de conférences   ......   http://upsilon.cc/zack   ......   . . o
Debian Project Leader    .......   @zack on identi.ca   .......    o o o
« the first rule of tautology club is the first rule of tautology club »

[-- Attachment #1.2: 0003-notmuch-mutt-XDG_CACHE_HOME-support-as-per-XDG-based.patch --]
[-- Type: text/x-diff, Size: 2254 bytes --]

From f68f36448f5bc63211c12b9e53e9db603ed76178 Mon Sep 17 00:00:00 2001
From: Stefano Zacchiroli <zack@upsilon.cc>
Date: Mon, 26 Mar 2012 20:47:34 +0200
Subject: [PATCH] notmuch-mutt: $XDG_CACHE_HOME support as per XDG basedir
 spec

---
 contrib/notmuch-mutt/notmuch-mutt    |    4 +++-
 contrib/notmuch-mutt/notmuch-mutt.rc |    4 ++--
 2 files changed, 5 insertions(+), 3 deletions(-)
 mode change 100755 => 100644 contrib/notmuch-mutt/notmuch-mutt

diff --git a/contrib/notmuch-mutt/notmuch-mutt b/contrib/notmuch-mutt/notmuch-mutt
old mode 100755
new mode 100644
index 29674ec..9cd01ec
--- a/contrib/notmuch-mutt/notmuch-mutt
+++ b/contrib/notmuch-mutt/notmuch-mutt
@@ -20,7 +20,9 @@ use String::ShellQuote;
 use Term::ReadLine;
 
 
-my $cache_dir = "$ENV{HOME}/.cache/notmuch/mutt";
+my $xdg_cache_dir = "$ENV{HOME}/.cache";
+$xdg_cache_dir = $ENV{XDG_CACHE_HOME} if $ENV{XDG_CACHE_HOME};
+my $cache_dir = "$xdg_cache_dir/notmuch/mutt";
 
 
 # create an empty maildir (if missing) or empty an existing maildir"
diff --git a/contrib/notmuch-mutt/notmuch-mutt.rc b/contrib/notmuch-mutt/notmuch-mutt.rc
index 269f03f..c0ff000 100644
--- a/contrib/notmuch-mutt/notmuch-mutt.rc
+++ b/contrib/notmuch-mutt/notmuch-mutt.rc
@@ -1,8 +1,8 @@
 macro index <F8> \
-      "<enter-command>unset wait_key<enter><shell-escape>notmuch-mutt --prompt search<enter><change-folder-readonly>~/.cache/notmuch/mutt/results<enter>" \
+      "<enter-command>unset wait_key<enter><shell-escape>notmuch-mutt --prompt search<enter><change-folder-readonly>`echo ${XDG_CACHE_HOME:-$HOME/.cache}/notmuch/mutt/results`<enter>" \
       "notmuch: search mail"
 macro index <F9> \
-      "<enter-command>unset wait_key<enter><pipe-message>notmuch-mutt thread<enter><change-folder-readonly>~/.cache/notmuch/mutt/results<enter><enter-command>set wait_key<enter>" \
+      "<enter-command>unset wait_key<enter><pipe-message>notmuch-mutt thread<enter><change-folder-readonly>`echo ${XDG_CACHE_HOME:-$HOME/.cache}/notmuch/mutt/results`<enter><enter-command>set wait_key<enter>" \
       "notmuch: reconstruct thread"
 macro index <F6> \
       "<enter-command>unset wait_key<enter><pipe-message>notmuch-mutt tag -inbox<enter>" \
-- 
1.7.9.1


[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 828 bytes --]

^ permalink raw reply related	[flat|nested] 8+ messages in thread

* Re: Bug#628018: [PATCH] notmuch-mutt utility for notmuch/contrib/
  2012-03-26 15:29       ` Stefano Zacchiroli
  2012-03-26 18:52         ` Stefano Zacchiroli
@ 2012-03-26 19:03         ` Scott Barker
  2012-03-26 21:15           ` Stefano Zacchiroli
  1 sibling, 1 reply; 8+ messages in thread
From: Scott Barker @ 2012-03-26 19:03 UTC (permalink / raw)
  To: Stefano Zacchiroli; +Cc: notmuch

FYI, I use the following in my .muttrc, which includes an expansion of $HOME
in <change-folder-readonly>, and it works fine:

  macro index / "<shell-escape>mutt-notmuch --prompt search<enter><change-folder-readonly>$HOME/.cache/mutt_results<enter>" "notmuch search"

On Mon, Mar 26, 2012 at 05:29:02PM +0200, Stefano Zacchiroli wrote:
> On Mon, Mar 26, 2012 at 08:09:13AM -0700, Jameson Graef Rollins wrote:
> > > Another thing is this .cache hardcoding. Should this be resolved
> > > first by using $XDG_CACHE_HOME, (then *MAYBE* $XDG_CONFIG_HOME/.cache)
> > > and finally $HOME/.cache
> > 
> > These are good points.  I agree that since ~/.cache is an XDG standard
> > we should resolve the appropriate environment variables.
> 
> Heya, thanks for your feedback. I agree as well!
> 
> But while it's trivial to make notmuch-mutt itself support
> $XDG_CACHE_HOME, it is less so for the Mutt configuration snippet
> (i.e. the notmuch-mutt.rc file which is part of my submission). AFAICT
> the <change-folder-readonly> function does not support variable
> expansions, not to mention default values while doing so. As a result, I
> can easily support $XDG_CACHE_HOME for, say, the history file, but I
> don't know how to make mutt look in some $XDG_CACHE_HOME derived
> directory. (Yes, I'm excluding hackish solutions like have mutt look
> always in the same dir, and make that dir a "moving" symlink that will
> be changed by notmuch-mutt upon execution. That seems to defeat the
> benefits of the XDG specification, at least partly.)
> 
> Bottom line: I'll be happy to properly support $XDG_CACHE_HOME, but I'm
> in need on suggestions of how to do so for the Mutt configuration part.
> 
> > If notmuch-mutt is accepted into notmuch upstream then it really becomes
> > a part of notmuch and isn't really "public" anymore (at least in the
> > sense that you're using).  So I don't really see any problem with having
> > it use ~/.cache/notmuch.
> 
> My thought exactly.
> 
> The proposal of documenting how people should use ~/.cache/notmuch is
> great, but I was hoping it can be overlooked for contrib stuff that has
> been vetted by you folks.
> 
> Thanks for your help (and for notmuch!)
> Cheers.
> -- 
> Stefano Zacchiroli     zack@{upsilon.cc,pps.jussieu.fr,debian.org} . o .
> Maître de conférences   ......   http://upsilon.cc/zack   ......   . . o
> Debian Project Leader    .......   @zack on identi.ca   .......    o o o
> « the first rule of tautology club is the first rule of tautology club »
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

-- 
Scott Barker
Linux Consultant
scott@mostlylinux.ca
http://www.mostlylinux.ca

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: Bug#628018: [PATCH] notmuch-mutt utility for notmuch/contrib/
  2012-03-26 19:03         ` Scott Barker
@ 2012-03-26 21:15           ` Stefano Zacchiroli
  0 siblings, 0 replies; 8+ messages in thread
From: Stefano Zacchiroli @ 2012-03-26 21:15 UTC (permalink / raw)
  To: notmuch

On Mon, Mar 26, 2012 at 01:03:32PM -0600, Scott Barker wrote:
> FYI, I use the following in my .muttrc, which includes an expansion of $HOME
> in <change-folder-readonly>, and it works fine:
> 
>   macro index / "<shell-escape>mutt-notmuch --prompt search<enter><change-folder-readonly>$HOME/.cache/mutt_results<enter>" "notmuch search"

Right, but I need support for variable expansions with defaults, because
there's no guarantee that $XDG_CACHE_HOME is defined in user
environment. I.e., I need the equivalent of shell ${name:-default}
idiom.

AFAICT that is not supported by Mutt natively. Hence the need of
resorting to shell escaping.

Hope this explains,
-- 
Stefano Zacchiroli     zack@{upsilon.cc,pps.jussieu.fr,debian.org} . o .
Maître de conférences   ......   http://upsilon.cc/zack   ......   . . o
Debian Project Leader    .......   @zack on identi.ca   .......    o o o
« the first rule of tautology club is the first rule of tautology club »

^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2012-03-26 21:15 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-03-26 10:32 [Stefano Zacchiroli] Bug#628018: [PATCH] mutt-notmuch in notmuch contrib David Bremner
2012-03-26 10:37 ` [Stefano Zacchiroli] Bug#628018: [PATCH] notmuch-mutt utility for notmuch/contrib/ David Bremner
2012-03-26 12:34   ` Tomi Ollila
2012-03-26 15:09     ` Jameson Graef Rollins
2012-03-26 15:29       ` Stefano Zacchiroli
2012-03-26 18:52         ` Stefano Zacchiroli
2012-03-26 19:03         ` Scott Barker
2012-03-26 21:15           ` Stefano Zacchiroli

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).