]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/LeiToMail.pm
update copyrights for 2021
[public-inbox.git] / lib / PublicInbox / LeiToMail.pm
index 294291b2da1bb1a379f5b456f8ff5f7f8e284d57..851c015bee36847f8e640dbdee0743e76c2afd0f 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2020 all contributors <meta@public-inbox.org>
+# Copyright (C) 2020-2021 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
 # Writes PublicInbox::Eml objects atomically to a mbox variant or Maildir
@@ -8,12 +8,12 @@ use v5.10.1;
 use PublicInbox::Eml;
 use PublicInbox::Lock;
 use PublicInbox::ProcessPipe;
-use PublicInbox::SharedKV;
 use PublicInbox::Spawn qw(which spawn popen_rd);
-use PublicInbox::ContentHash qw(content_hash);
+use PublicInbox::LeiDedupe;
 use Symbol qw(gensym);
 use IO::Handle; # ->autoflush
-use Fcntl qw(SEEK_SET);
+use Fcntl qw(SEEK_SET SEEK_END O_CREAT O_EXCL O_WRONLY);
+use Errno qw(EEXIST ESPIPE ENOENT);
 
 my %kw2char = ( # Maildir characters
        draft => 'D',
@@ -53,14 +53,15 @@ sub _mbox_hdr_buf ($$$) {
        $buf;
 }
 
-sub write_in_full ($$$) {
-       my ($fh, $buf, $atomic) = @_;
-       if ($atomic) {
-               defined(my $w = syswrite($fh, $$buf)) or die "write: $!";
-               $w == length($$buf) or die "short write: $w != ".length($$buf);
-       } else {
-               print $fh $$buf or die "print: $!";
-       }
+sub atomic_append { # for on-disk destinations (O_APPEND, or O_EXCL)
+       my ($fh, $buf) = @_;
+       defined(my $w = syswrite($fh, $$buf)) or die "write: $!";
+       $w == length($$buf) or die "short write: $w != ".length($$buf);
+}
+
+sub _print_full {
+       my ($fh, $buf) = @_;
+       print $fh $$buf or die "print: $!";
 }
 
 sub eml2mboxrd ($;$) {
@@ -118,18 +119,6 @@ sub eml2mboxcl2 {
        $buf;
 }
 
-sub mkmaildir ($) {
-       my ($maildir) = @_;
-       for (qw(new tmp cur)) {
-               my $d = "$maildir/$_";
-               next if -d $d;
-               require File::Path;
-               if (!File::Path::mkpath($d) && !-d $d) {
-                       die "failed to mkpath($d): $!\n";
-               }
-       }
-}
-
 sub git_to_mail { # git->cat_async callback
        my ($bref, $oid, $type, $size, $arg) = @_;
        if ($type ne 'blob') {
@@ -226,49 +215,147 @@ sub dup_src ($) {
        $dup;
 }
 
-# --augment existing output destination, without duplicating anything
+# --augment existing output destination, with deduplication
 sub _augment { # MboxReader eml_cb
        my ($eml, $lei) = @_;
-       $lei->{skv}->set_maybe(content_hash($eml), '');
+       # ignore return value, just populate the skv
+       $lei->{dedupe}->is_dup($eml);
 }
 
 sub _mbox_write_cb ($$$$) {
        my ($cls, $mbox, $dst, $lei) = @_;
        my $m = "eml2$mbox";
        my $eml2mbox = $cls->can($m) or die "$cls->$m missing";
-       my ($out, $pipe_lk);
-       open $out, '+>>', $dst or die "open $dst: $!";
-       # Perl does SEEK_END even with O_APPEND :<
-       seek($out, 0, SEEK_SET) or die "seek $dst: $!";
-       my $atomic = !!(($lei->{opt}->{jobs} // 0) > 1);
-       $lei->{skv} = PublicInbox::SharedKV->new;
-       $lei->{skv}->dbh;
+       my ($out, $pipe_lk, $seekable);
+       # XXX should we support /dev/stdout.gz ?
+       if ($dst eq '/dev/stdout') {
+               $out = $lei->{1};
+       } else { # TODO: mbox locking (but mairix doesn't...)
+               my $mode = -p $dst ? '>' : '+>>';
+               if (-f _ && !$lei->{opt}->{augment} and !unlink($dst)) {
+                       die "unlink $dst: $!" if $! != ENOENT;
+               }
+               open $out, $mode, $dst or die "open $dst: $!";
+               # Perl does SEEK_END even with O_APPEND :<
+               $seekable = seek($out, 0, SEEK_SET);
+               die "seek $dst: $!\n" if !$seekable && $! != ESPIPE;
+       }
+       my $jobs = $lei->{opt}->{jobs} // 0;
        state $zsfx_allow = join('|', keys %zsfx2cmd);
        my ($zsfx) = ($dst =~ /\.($zsfx_allow)\z/);
+       my $write = $jobs > 1 && !$zsfx ? \&atomic_append : \&_print_full;
+       my $dedupe = $lei->{dedupe} = PublicInbox::LeiDedupe->new($lei);
        if ($lei->{opt}->{augment}) {
-               my $rd = $zsfx ? decompress_src($out, $zsfx, $lei) :
-                               dup_src($out);
-               PublicInbox::MboxReader->$mbox($rd, \&_augment, $lei);
-       } else {
-               truncate($out, 0) or die "truncate $dst: $!";
+               die "cannot augment $dst, not seekable\n" if !$seekable;
+               if (-s $out && $dedupe->prepare_dedupe) {
+                       my $rd = $zsfx ? decompress_src($out, $zsfx, $lei) :
+                                       dup_src($out);
+                       PublicInbox::MboxReader->$mbox($rd, \&_augment, $lei);
+               }
+               # maybe some systems don't honor O_APPEND, Perl does this:
+               seek($out, 0, SEEK_END) or die "seek $dst: $!";
+               $dedupe->pause_dedupe if $jobs; # are we forking?
        }
+       $dedupe->prepare_dedupe if !$jobs;
        ($out, $pipe_lk) = compress_dst($out, $zsfx, $lei) if $zsfx;
-       sub {
+       sub { # for git_to_mail
                my ($buf, $oid, $kw) = @_;
                my $eml = PublicInbox::Eml->new($buf);
-               if ($lei->{skv}->set_maybe(content_hash($eml), '')) {
+               if (!$dedupe->is_dup($eml, $oid)) {
                        $buf = $eml2mbox->($eml, $kw);
                        my $lock = $pipe_lk->lock_for_scope if $pipe_lk;
-                       write_in_full($out, $buf, $atomic);
+                       $write->($out, $buf);
                }
        }
 }
 
+sub _maildir_each_file ($$;@) {
+       my ($dir, $cb, @arg) = @_;
+       for my $d (qw(new/ cur/)) {
+               my $pfx = $dir.$d;
+               opendir my $dh, $pfx or next;
+               while (defined(my $fn = readdir($dh))) {
+                       $cb->($pfx.$fn, @arg) if $fn =~ /:2,[A-Za-z]*\z/;
+               }
+       }
+}
+
+sub _augment_file { # _maildir_each_file cb
+       my ($f, $lei) = @_;
+       my $eml = PublicInbox::InboxWritable::eml_from_path($f) or return;
+       _augment($eml, $lei);
+}
+
+# _maildir_each_file callback, \&CORE::unlink doesn't work with it
+sub _unlink { unlink($_[0]) }
+
+sub _buf2maildir {
+       my ($dst, $buf, $oid, $kw) = @_;
+       my $sfx = join('', sort(map { $kw2char{$_} // () } @$kw));
+       my $rand = ''; # chosen by die roll :P
+       my ($tmp, $fh, $final);
+       do {
+               $tmp = $dst.'tmp/'.$rand."oid=$oid";
+       } while (!sysopen($fh, $tmp, O_CREAT|O_EXCL|O_WRONLY) &&
+               $! == EEXIST && ($rand = int(rand 0x7fffffff).','));
+       if (print $fh $$buf and close($fh)) {
+               $dst .= $sfx eq '' ? 'new/' : 'cur/';
+               $rand = '';
+               do {
+                       $final = $dst.$rand."oid=$oid:2,$sfx";
+               } while (!link($tmp, $final) && $! == EEXIST &&
+                       ($rand = int(rand 0x7fffffff).','));
+               unlink($tmp) or warn "W: failed to unlink $tmp: $!\n";
+       } else {
+               my $err = $!;
+               unlink($tmp);
+               die "Error writing $oid to $dst: $err";
+       }
+}
+
+
+sub _maildir_write_cb ($$) {
+       my ($dst, $lei) = @_;
+       $dst .= '/' unless substr($dst, -1) eq '/';
+       my $dedupe = $lei->{dedupe} = PublicInbox::LeiDedupe->new($lei, $dst);
+       my $jobs = $lei->{opt}->{jobs} // 0;
+       if ($lei->{opt}->{augment}) {
+               if ($dedupe && $dedupe->prepare_dedupe) {
+                       require PublicInbox::InboxWritable; # eml_from_path
+                       _maildir_each_file($dst, \&_augment_file, $lei);
+                       $dedupe->pause_dedupe if $jobs; # are we forking?
+               }
+       } else { # clobber existing Maildir
+               _maildir_each_file($dst, \&_unlink);
+       }
+       for my $x (qw(tmp new cur)) {
+               my $d = $dst.$x;
+               next if -d $d;
+               require File::Path;
+               if (!File::Path::mkpath($d) && !-d $d) {
+                       die "failed to mkpath($d): $!\n";
+               }
+       }
+       $dedupe->prepare_dedupe if $dedupe && !$jobs;
+       sub { # for git_to_mail
+               my ($buf, $oid, $kw) = @_;
+               return _buf2maildir($dst, $buf, $oid, $kw) if !$dedupe;
+               my $eml = PublicInbox::Eml->new($$buf); # copy buf
+               return if $dedupe->is_dup($eml, $oid);
+               undef $eml;
+               _buf2maildir($dst, $buf, $oid, $kw);
+       }
+}
+
 sub write_cb { # returns a callback for git_to_mail
        my ($cls, $dst, $lei) = @_;
+       require PublicInbox::LeiDedupe;
        if ($dst =~ s!\A(mbox(?:rd|cl|cl2|o))?:!!) {
                _mbox_write_cb($cls, $1, $dst, $lei);
+       } elsif ($dst =~ s!\A[Mm]aildir:!!) { # typically capitalized
+               _maildir_write_cb($dst, $lei);
        }
+       # TODO: Maildir, MH, IMAP, JMAP ...
 }
 
 1;