X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=contrib%2Fnotmuch-mutt%2Fnotmuch-mutt;h=d1e2c084b4208f093f97a47e81169da28a65d9ad;hp=d14709df6eb3bccdd054a18f0ffa1cc984167d00;hb=HEAD;hpb=fffb92da8e09bb2fed63dc565e6ab7fa9b44d2f9 diff --git a/contrib/notmuch-mutt/notmuch-mutt b/contrib/notmuch-mutt/notmuch-mutt index d14709df..b81252c8 100755 --- a/contrib/notmuch-mutt/notmuch-mutt +++ b/contrib/notmuch-mutt/notmuch-mutt @@ -1,8 +1,8 @@ -#!/usr/bin/perl -w +#!/usr/bin/env perl # # notmuch-mutt - notmuch (of a) helper for Mutt # -# Copyright: © 2011-2012 Stefano Zacchiroli +# Copyright: © 2011-2015 Stefano Zacchiroli # License: GNU General Public License (GPL), version 3 or above # # See the bottom of this file for more documentation. @@ -12,89 +12,92 @@ use strict; use warnings; use File::Path; +use File::Basename; +use File::Find; use Getopt::Long qw(:config no_getopt_compat); -use Mail::Internet; +use Mail::Header; use Mail::Box::Maildir; use Pod::Usage; -use String::ShellQuote; use Term::ReadLine; use Digest::SHA; -use File::Which; 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"; +sub die_dir($$) { + my ($maildir, $error) = @_; + die "notmuch-mutt: search cache maildir $maildir $error\n". + "Please ensure that the notmuch-mutt search cache Maildir\n". + "contains no subfolders or real mail data, only symlinks to mail\n"; +} -# 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(); +sub die_subdir($$$) { + my ($maildir, $subdir, $error) = @_; + die_dir($maildir, "subdir $subdir $error"); } -# Match files by size and SHA-256; then delete duplicates -sub builtin_remove_dups($) { - my ($maildir) = @_; - my (%size_to_files, %sha_to_files); +# check that the search cache maildir is that and not a real maildir +# otherwise there could be data loss when the search cache is emptied +sub check_search_cache_maildir($) { + my ($maildir) = (@_); + + return unless -e $maildir; - # Group files by matching sizes - foreach my $file (glob("$maildir/cur/*")) { - my $size = -s $file; - push(@{$size_to_files{$size}}, $file) if $size; + -d $maildir or die_dir($maildir, 'is not a directory'); + + opendir(my $mdh, $maildir) or die_dir($maildir, "cannot be opened: $!"); + my @contents = grep { !/^\.\.?$/ } readdir $mdh; + closedir $mdh; + + my @required = ('cur', 'new', 'tmp'); + foreach my $d (@required) { + -l "$maildir/$d" and die_dir($maildir, "contains symlink $d"); + -e "$maildir/$d" or die_subdir($maildir, $d, 'is missing'); + -d "$maildir/$d" or die_subdir($maildir, $d, 'is not a directory'); + find(sub { + $_ eq '.' and return; + $_ eq '..' and return; + -l $_ or die_subdir($maildir, $d, "contains non-symlink $_"); + }, "$maildir/$d"); } - foreach my $same_size_files (values %size_to_files) { - # Don't run sha unless there is another file of the same size - next if scalar(@$same_size_files) < 2; - %sha_to_files = (); - - # Group files with matching sizes by SHA-256 - foreach my $file (@$same_size_files) { - open(my $fh, '<', $file) or next; - binmode($fh); - my $sha256hash = Digest::SHA->new(256)->addfile($fh)->hexdigest; - close($fh); - - push(@{$sha_to_files{$sha256hash}}, $file); - } - - # Remove duplicates - foreach my $same_sha_files (values %sha_to_files) { - next if scalar(@$same_sha_files) < 2; - unlink(@{$same_sha_files}[1..$#$same_sha_files]); - } + my %required = map { $_ => 1 } @required; + foreach my $d (@contents) { + -l "$maildir/$d" and die_dir( $maildir, "contains symlink $d"); + -d "$maildir/$d" or die_dir( $maildir, "contains non-directory $d"); + exists($required{$d}) or die_dir( $maildir, "contains directory $d"); } } -# Use either fdupes or the built-in scanner to detect and remove duplicate -# search results in the maildir -sub remove_duplicates($) { - my ($maildir) = @_; - - my $fdupes = which("fdupes"); - if ($fdupes) { - system("$fdupes --hardlinks --symlinks --delete --noprompt" - . " --quiet $maildir/cur/ > /dev/null"); - } else { - builtin_remove_dups($maildir); - } +# create an empty search cache maildir (if missing) or empty existing one +sub empty_search_cache_maildir($) { + my ($maildir) = (@_); + rmtree($maildir) if (-d $maildir); + my $folder = new Mail::Box::Maildir(folder => $maildir, + create => 1); + $folder->close(); } # search($maildir, $remove_dups, $query) # search mails according to $query with notmuch; store results in $maildir sub search($$$) { my ($maildir, $remove_dups, $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/"); - remove_duplicates($maildir) if ($remove_dups); + my $dup_option = ""; + + my @args = qw/notmuch search --output=files/; + push @args, "--duplicate=1" if $remove_dups; + push @args, $query; + + check_search_cache_maildir($maildir); + empty_search_cache_maildir($maildir); + open my $pipe, '-|', @args or die "Running @args failed: $!\n"; + while (<$pipe>) { + chomp; + my $ln = "$maildir/cur/" . basename $_; + symlink $_, "$ln" or warn "Failed to symlink '$_', '$ln': $!\n"; + } } sub prompt($$) { @@ -120,9 +123,29 @@ sub prompt($$) { } sub get_message_id() { - my $mail = Mail::Internet->new(\*STDIN); - $mail->head->get("message-id") =~ /^<(.*)>$/; # get message-id - return $1; + my $mid = undef; + my @headers = (); + + while () { # collect header lines in @headers + push(@headers, $_); + last if $_ =~ /^$/; + } + my $head = Mail::Header->new(\@headers); + $mid = $head->get("message-id") or undef; + + if ($mid) { # Message-ID header found + $mid =~ /^<(.*)>$/; # extract message id + $mid = $1; + } else { # Message-ID header not found, synthesize a message id + # based on SHA1, as notmuch would do. See: + # https://git.notmuchmail.org/git/notmuch/blob/HEAD:/lib/sha1.c + my $sha = Digest::SHA->new(1); + $sha->add($_) foreach(@headers); + $sha->addfile(\*STDIN); + $mid = 'notmuch-sha1-' . $sha->hexdigest; + } + + return $mid; } sub search_action($$$@) { @@ -142,19 +165,24 @@ sub thread_action($$@) { my ($results_dir, $remove_dups, @params) = @_; my $mid = get_message_id(); - my $search_cmd = 'notmuch search --output=threads ' . shell_quote("id:$mid"); - my $tid = `$search_cmd`; # get thread id - chomp($tid); + if (! defined $mid) { + die "notmuch-mutt: cannot find Message-Id, abort.\n"; + } + + $mid =~ s/ //g; # notmuch strips spaces before storing Message-Id + $mid =~ s/"/""""/g; # escape all double quote characters twice - search($results_dir, $remove_dups, $tid); + search($results_dir, $remove_dups, qq{thread:"{id:""$mid""}"}); } sub tag_action(@) { my $mid = get_message_id(); + defined $mid or die "notmuch-mutt: cannot find Message-Id, abort.\n"; - system("notmuch tag " - . shell_quote(join(' ', @_)) - . " id:$mid"); + $mid =~ s/ //g; # notmuch strips spaces before storing Message-Id + $mid =~ s/"/""/g; # escape all double quote characters + + system("notmuch", "tag", @_, "--", qq{id:"$mid"}); } sub die_usage() { @@ -246,7 +274,10 @@ Instead of using command line search terms, prompt the user for them (only for =item --remove-dups -Remove duplicates from search results. +Remove emails with duplicate message-ids from search results. (Passes +--duplicate=1 to notmuch search command.) Note this can hide search +results if an email accidentally or maliciously uses the same message-id +as a different email. =item -h @@ -264,13 +295,23 @@ the following in your Mutt configuration (usually one of: F<~/.muttrc>, F, or a configuration snippet under F): macro index \ - "unset wait_keynotmuch-mutt -r --prompt search~/.cache/notmuch/mutt/results" \ + "set my_old_pipe_decode=\$pipe_decode my_old_wait_key=\$wait_key nopipe_decode nowait_key\ + notmuch-mutt -r --prompt search\ + `echo ${XDG_CACHE_HOME:-$HOME/.cache}/notmuch/mutt/results`\ + set pipe_decode=\$my_old_pipe_decode wait_key=\$my_old_wait_key" \ "notmuch: search mail" + macro index \ - "unset wait_keynotmuch-mutt -r thread~/.cache/notmuch/mutt/resultsset wait_key" \ + "set my_old_pipe_decode=\$pipe_decode my_old_wait_key=\$wait_key nopipe_decode nowait_key\ + notmuch-mutt -r thread\ + `echo ${XDG_CACHE_HOME:-$HOME/.cache}/notmuch/mutt/results`\ + set pipe_decode=\$my_old_pipe_decode wait_key=\$my_old_wait_key" \ "notmuch: reconstruct thread" + macro index \ - "unset wait_keynotmuch-mutt tag -- -inbox" \ + "set my_old_pipe_decode=\$pipe_decode my_old_wait_key=\$wait_key nopipe_decode nowait_key\ + notmuch-mutt tag -- -inbox\ + set pipe_decode=\$my_old_pipe_decode wait_key=\$my_old_wait_key" \ "notmuch: remove message from inbox" The first macro (activated by ) prompts the user for notmuch search terms