]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/LeiToMail.pm
lei convert: mail format conversion sub-command
[public-inbox.git] / lib / PublicInbox / LeiToMail.pm
index 8e58ad110fa8d0f56d82c2d620f6f3cca445c573..f0adc44f23e6088b13e40d43b01fec9fa1705c7d 100644 (file)
@@ -11,11 +11,18 @@ use PublicInbox::Lock;
 use PublicInbox::ProcessPipe;
 use PublicInbox::Spawn qw(which spawn popen_rd);
 use PublicInbox::LeiDedupe;
+use PublicInbox::OnDestroy;
+use PublicInbox::Git;
+use PublicInbox::GitAsyncCat;
 use Symbol qw(gensym);
 use IO::Handle; # ->autoflush
 use Fcntl qw(SEEK_SET SEEK_END O_CREAT O_EXCL O_WRONLY);
-use Errno qw(EEXIST ESPIPE ENOENT);
-use PublicInbox::Git;
+use Errno qw(EEXIST ESPIPE ENOENT EPIPE);
+my ($maildir_each_file);
+
+# struggles with short-lived repos, Gcf2Client makes little sense with lei;
+# but we may use in-process libgit2 in the future.
+$PublicInbox::GitAsyncCat::GCF2C = 0;
 
 my %kw2char = ( # Maildir characters
        draft => 'D',
@@ -32,14 +39,14 @@ my %kw2status = (
 );
 
 sub _mbox_hdr_buf ($$$) {
-       my ($eml, $type, $kw) = @_;
+       my ($eml, $type, $smsg) = @_;
        $eml->header_set($_) for (qw(Lines Bytes Content-Length));
 
        # Messages are always 'O' (non-\Recent in IMAP), it saves
        # MUAs the trouble of rewriting the mbox if no other
        # changes are made
        my %hdr = (Status => [ 'O' ]); # set Status, X-Status
-       for my $k (@$kw) {
+       for my $k (@{$smsg->{kw} // []}) {
                if (my $ent = $kw2status{$k}) {
                        push @{$hdr{$ent->[0]}}, $ent->[1];
                } else { # X-Label?
@@ -53,26 +60,30 @@ sub _mbox_hdr_buf ($$$) {
 
        # fixup old bug from import (pre-a0c07cba0e5d8b6a)
        $$buf =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s;
+       my $ident = $smsg->{blob} // 'lei';
+       if (defined(my $pct = $smsg->{pct})) { $ident .= "=$pct" }
 
        substr($$buf, 0, 0, # prepend From line
-               "From lei\@$type Thu Jan  1 00:00:00 1970$eml->{crlf}");
+               "From $ident\@$type Thu Jan  1 00:00:00 1970$eml->{crlf}");
        $buf;
 }
 
 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: $!";
+       my ($lei, $buf) = @_;
+       if (defined(my $w = syswrite($lei->{1} // return, $$buf))) {
+               return if $w == length($$buf);
+               $buf = "short atomic write: $w != ".length($$buf);
+       } elsif ($! == EPIPE) {
+               return $lei->note_sigpipe(1);
+       } else {
+               $buf = "atomic write: $!";
+       }
+       $lei->fail($buf);
 }
 
 sub eml2mboxrd ($;$) {
-       my ($eml, $kw) = @_;
-       my $buf = _mbox_hdr_buf($eml, 'mboxrd', $kw);
+       my ($eml, $smsg) = @_;
+       my $buf = _mbox_hdr_buf($eml, 'mboxrd', $smsg);
        if (my $bdy = delete $eml->{bdy}) {
                $$bdy =~ s/^(>*From )/>$1/gm;
                $$buf .= $eml->{crlf};
@@ -84,8 +95,8 @@ sub eml2mboxrd ($;$) {
 }
 
 sub eml2mboxo {
-       my ($eml, $kw) = @_;
-       my $buf = _mbox_hdr_buf($eml, 'mboxo', $kw);
+       my ($eml, $smsg) = @_;
+       my $buf = _mbox_hdr_buf($eml, 'mboxo', $smsg);
        if (my $bdy = delete $eml->{bdy}) {
                $$bdy =~ s/^From />From /gm;
                $$buf .= $eml->{crlf};
@@ -108,8 +119,8 @@ sub _mboxcl_common ($$$) {
 
 # mboxcl still escapes "From " lines
 sub eml2mboxcl {
-       my ($eml, $kw) = @_;
-       my $buf = _mbox_hdr_buf($eml, 'mboxcl', $kw);
+       my ($eml, $smsg) = @_;
+       my $buf = _mbox_hdr_buf($eml, 'mboxcl', $smsg);
        my $crlf = $eml->{crlf};
        if (my $bdy = delete $eml->{bdy}) {
                $$bdy =~ s/^From />From /gm;
@@ -121,8 +132,8 @@ sub eml2mboxcl {
 
 # mboxcl2 has no "From " escaping
 sub eml2mboxcl2 {
-       my ($eml, $kw) = @_;
-       my $buf = _mbox_hdr_buf($eml, 'mboxcl2', $kw);
+       my ($eml, $smsg) = @_;
+       my $buf = _mbox_hdr_buf($eml, 'mboxcl2', $smsg);
        my $crlf = $eml->{crlf};
        if (my $bdy = delete $eml->{bdy}) {
                _mboxcl_common($buf, $bdy, $crlf);
@@ -140,10 +151,11 @@ sub git_to_mail { # git->cat_async callback
                        warn "unexpected type=$type for $oid\n";
                }
        }
-       if ($size > 0) {
-               my ($write_cb, $kw) = @$arg;
-               $write_cb->($bref, $oid, $kw);
+       my ($write_cb, $smsg) = @$arg;
+       if ($smsg->{blob} ne $oid) {
+               die "BUG: expected=$smsg->{blob} got=$oid";
        }
+       $write_cb->($bref, $smsg) if $size > 0;
 }
 
 sub reap_compress { # dwaitpid callback
@@ -203,15 +215,16 @@ sub _post_augment_mbox { # open a compressor process
        my ($self, $lei) = @_;
        my $zsfx = $self->{zsfx} or return;
        my $cmd = zsfx2cmd($zsfx, undef, $lei);
-       pipe(my ($r, $w)) or die "pipe: $!";
+       my ($r, $w) = @{delete $lei->{zpipe}};
        my $rdr = { 0 => $r, 1 => $lei->{1}, 2 => $lei->{2} };
        my $pid = spawn($cmd, $lei->{env}, $rdr);
-       $lei->{"pid.$pid"} = $cmd;
        my $pp = gensym;
-       tie *$pp, 'PublicInbox::ProcessPipe', $pid, $w, \&reap_compress, $lei;
+       my $dup = bless { "pid.$pid" => $cmd }, ref($lei);
+       $dup->{$_} = $lei->{$_} for qw(2 sock);
+       tie *$pp, 'PublicInbox::ProcessPipe', $pid, $w, \&reap_compress, $dup;
        $lei->{1} = $pp;
        die 'BUG: unexpected {ovv}->{lock_path}' if $lei->{ovv}->{lock_path};
-       $lei->{ovv}->ovv_out_lk_init if ($lei->{opt}->{jobs} // 2) > 1;
+       $lei->{ovv}->ovv_out_lk_init;
 }
 
 sub decompress_src ($$$) {
@@ -222,9 +235,7 @@ sub decompress_src ($$$) {
 
 sub dup_src ($) {
        my ($in) = @_;
-       # fileno needed because wq_set_recv_modes only used ">&=" for {1}
-       # and Perl blindly trusts that to reject the '+' (readability flag)
-       open my $dup, '+>>&=', fileno($in) or die "dup: $!";
+       open my $dup, '+>>&', $in or die "dup: $!";
        $dup;
 }
 
@@ -240,57 +251,49 @@ sub _mbox_write_cb ($$) {
        my $ovv = $lei->{ovv};
        my $m = 'eml2'.$ovv->{fmt};
        my $eml2mbox = $self->can($m) or die "$self->$m missing";
-       my $out = $lei->{1} // die "no stdout ($m, $ovv->{dst})"; # redirected earlier
-       $out->autoflush(1);
-       my $write = $ovv->{lock_path} ? \&_print_full : \&atomic_append;
+       $lei->{1} // die "no stdout ($m, $ovv->{dst})"; # redirected earlier
+       $lei->{1}->autoflush(1);
+       my $atomic_append = !defined($ovv->{lock_path});
        my $dedupe = $lei->{dedupe};
        $dedupe->prepare_dedupe;
        sub { # for git_to_mail
-               my ($buf, $oid, $kw) = @_;
-               return unless $out;
-               my $eml = PublicInbox::Eml->new($buf);
-               if (!$dedupe->is_dup($eml, $oid)) {
-                       $buf = $eml2mbox->($eml, $kw);
-                       my $lk = $ovv->lock_for_scope;
-                       eval { $write->($out, $buf) };
-                       if ($@) {
-                               die $@ if ref($@) ne 'PublicInbox::SIGPIPE';
-                               undef $out
-                       }
-               }
-       }
-}
-
-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/;
-               }
+               my ($buf, $smsg, $eml) = @_;
+               $eml //= PublicInbox::Eml->new($buf);
+               return if $dedupe->is_dup($eml, $smsg->{blob});
+               $buf = $eml2mbox->($eml, $smsg);
+               return atomic_append($lei, $buf) if $atomic_append;
+               my $lk = $ovv->lock_for_scope;
+               $lei->out($$buf);
        }
 }
 
-sub _augment_file { # _maildir_each_file cb
+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
+# maildir_each_file callback, \&CORE::unlink doesn't work with it
 sub _unlink { unlink($_[0]) }
 
+sub _rand () {
+       state $seq = 0;
+       sprintf('%x,%x,%x,%x', rand(0xffffffff), time, $$, ++$seq);
+}
+
 sub _buf2maildir {
-       my ($dst, $buf, $oid, $kw) = @_;
+       my ($dst, $buf, $smsg) = @_;
+       my $kw = $smsg->{kw} // [];
        my $sfx = join('', sort(map { $kw2char{$_} // () } @$kw));
        my $rand = ''; # chosen by die roll :P
-       my ($tmp, $fh, $final);
+       my ($tmp, $fh, $final, $ok);
+       my $common = $smsg->{blob} // _rand;
+       if (defined(my $pct = $smsg->{pct})) { $common .= "=$pct" }
        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)) {
+               $tmp = $dst.'tmp/'.$rand.$common;
+       } while (!($ok = sysopen($fh, $tmp, O_CREAT|O_EXCL|O_WRONLY)) &&
+               $! == EEXIST && ($rand = _rand.','));
+       if ($ok && print $fh $$buf and close($fh)) {
                # ignore new/ and write only to cur/, otherwise MUAs
                # with R/W access to the Maildir will end up doing
                # a mass rename which can take a while with thousands
@@ -298,29 +301,32 @@ sub _buf2maildir {
                $dst .= 'cur/';
                $rand = '';
                do {
-                       $final = $dst.$rand."oid=$oid:2,$sfx";
+                       $final = $dst.$rand.$common.':2,'.$sfx;
                } while (!link($tmp, $final) && $! == EEXIST &&
-                       ($rand = int(rand 0x7fffffff).','));
+                       ($rand = _rand.','));
                unlink($tmp) or warn "W: failed to unlink $tmp: $!\n";
        } else {
-               my $err = $!;
+               my $err = "Error writing $smsg->{blob} to $dst: $!\n";
+               $_[0] = undef; # clobber dst
                unlink($tmp);
-               die "Error writing $oid to $dst: $err";
+               die $err;
        }
 }
 
 sub _maildir_write_cb ($$) {
        my ($self, $lei) = @_;
        my $dedupe = $lei->{dedupe};
-       $dedupe->prepare_dedupe;
+       $dedupe->prepare_dedupe if $dedupe;
        my $dst = $lei->{ovv}->{dst};
        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);
+               my ($buf, $smsg, $eml) = @_;
+               $dst // return $lei->fail; # dst may be undef-ed in last run
+               $buf //= \($eml->as_string);
+               return _buf2maildir($dst, $buf, $smsg) if !$dedupe;
+               $eml //= PublicInbox::Eml->new($$buf); # copy buf
+               return if $dedupe->is_dup($eml, $smsg->{blob});
                undef $eml;
-               _buf2maildir($dst, $buf, $oid, $kw);
+               _buf2maildir($dst, $buf, $smsg);
        }
 }
 
@@ -337,19 +343,41 @@ sub new {
        my $dst = $lei->{ovv}->{dst};
        my $self = bless {}, $cls;
        if ($fmt eq 'maildir') {
+               $maildir_each_file //= do {
+                       require PublicInbox::MdirReader;
+                       PublicInbox::MdirReader->can('maildir_each_file');
+               };
+               $lei->{opt}->{augment} and
+                       require PublicInbox::InboxWritable; # eml_from_path
                $self->{base_type} = 'maildir';
+               -e $dst && !-d _ and die
+                               "$dst exists and is not a directory\n";
                $lei->{ovv}->{dst} = $dst .= '/' if substr($dst, -1) ne '/';
        } elsif (substr($fmt, 0, 4) eq 'mbox') {
+               require PublicInbox::MboxReader if $lei->{opt}->{augment};
+               (-d $dst || (-e _ && !-w _)) and die
+                       "$dst exists and is not a writable file\n";
                $self->can("eml2$fmt") or die "bad mbox --format=$fmt\n";
                $self->{base_type} = 'mbox';
        } else {
                die "bad mail --format=$fmt\n";
        }
+       $self->{dst} = $dst;
        $lei->{dedupe} = PublicInbox::LeiDedupe->new($lei);
        $self;
 }
 
-sub _pre_augment_maildir {} # noop
+sub _pre_augment_maildir {
+       my ($self, $lei) = @_;
+       my $dst = $lei->{ovv}->{dst};
+       for my $x (qw(tmp new cur)) {
+               my $d = $dst.$x;
+               next if -d $d;
+               require File::Path;
+               File::Path::mkpath($d);
+               -d $d or die "$d is not a directory";
+       }
+}
 
 sub _do_augment_maildir {
        my ($self, $lei) = @_;
@@ -357,26 +385,15 @@ sub _do_augment_maildir {
        if ($lei->{opt}->{augment}) {
                my $dedupe = $lei->{dedupe};
                if ($dedupe && $dedupe->prepare_dedupe) {
-                       require PublicInbox::InboxWritable; # eml_from_path
-                       _maildir_each_file($dst, \&_augment_file, $lei);
+                       $maildir_each_file->($dst, \&_augment_file, $lei);
                        $dedupe->pause_dedupe;
                }
        } else { # clobber existing Maildir
-               _maildir_each_file($dst, \&_unlink);
+               $maildir_each_file->($dst, \&_unlink);
        }
 }
 
-sub _post_augment_maildir {
-       my ($self, $lei) = @_;
-       my $dst = $lei->{ovv}->{dst};
-       for my $x (qw(tmp new cur)) {
-               my $d = $dst.$x;
-               next if -d $d;
-               require File::Path;
-               File::Path::mkpath($d) or die "mkpath($d): $!";
-               -d $d or die "$d is not a directory";
-       }
-}
+sub _post_augment_maildir {} # noop
 
 sub _pre_augment_mbox {
        my ($self, $lei) = @_;
@@ -387,6 +404,7 @@ sub _pre_augment_mbox {
                        $! == ENOENT or die "unlink($dst): $!";
                }
                open my $out, $mode, $dst or die "open($dst): $!";
+               $lei->{old_1} = $lei->{1}; # keep for spawning MUA
                $lei->{1} = $out;
        }
        # Perl does SEEK_END even with O_APPEND :<
@@ -395,7 +413,9 @@ sub _pre_augment_mbox {
                die "seek($dst): $!\n";
        }
        state $zsfx_allow = join('|', keys %zsfx2cmd);
-       ($self->{zsfx}) = ($dst =~ /\.($zsfx_allow)\z/);
+       ($self->{zsfx}) = ($dst =~ /\.($zsfx_allow)\z/) or return;
+       pipe(my ($r, $w)) or die "pipe: $!";
+       $lei->{zpipe} = [ $r, $w ];
 }
 
 sub _do_augment_mbox {
@@ -410,7 +430,6 @@ sub _do_augment_mbox {
                my $rd = $zsfx ? decompress_src($out, $zsfx, $lei) :
                                dup_src($out);
                my $fmt = $lei->{ovv}->{fmt};
-               require PublicInbox::MboxReader;
                PublicInbox::MboxReader->$fmt($rd, \&_augment, $lei);
        }
        # maybe some systems don't honor O_APPEND, Perl does this:
@@ -418,7 +437,7 @@ sub _do_augment_mbox {
        $dedupe->pause_dedupe if $dedupe;
 }
 
-sub pre_augment { # fast (1 disk seek), runs in main daemon
+sub pre_augment { # fast (1 disk seek), runs in same process as post_augment
        my ($self, $lei) = @_;
        # _pre_augment_maildir, _pre_augment_mbox
        my $m = "_pre_augment_$self->{base_type}";
@@ -432,42 +451,53 @@ sub do_augment { # slow, runs in wq worker
        $self->$m($lei);
 }
 
-sub post_augment { # fast (spawn compressor or mkdir), runs in main daemon
-       my ($self, $lei) = @_;
+# fast (spawn compressor or mkdir), runs in same process as pre_augment
+sub post_augment {
+       my ($self, $lei, @args) = @_;
        # _post_augment_maildir, _post_augment_mbox
        my $m = "_post_augment_$self->{base_type}";
-       $self->$m($lei);
+       $self->$m($lei, @args);
+}
+
+sub ipc_atfork_child {
+       my ($self) = @_;
+       my $lei = delete $self->{lei};
+       $lei->lei_atfork_child;
+       if (my $zpipe = delete $lei->{zpipe}) {
+               $lei->{1} = $zpipe->[1];
+               close $zpipe->[0];
+       }
+       $self->{wcb} = $self->write_cb($lei);
+       $SIG{__WARN__} = PublicInbox::Eml::warn_ignore_cb();
+       $self->SUPER::ipc_atfork_child;
 }
 
 sub lock_free {
        $_[0]->{base_type} =~ /\A(?:maildir|mh|imap|jmap)\z/ ? 1 : 0;
 }
 
-sub write_mail { # via ->wq_do
-       my ($self, $git_dir, $oid, $lei, $kw) = @_;
-       my $not_done = delete $self->{4}; # write end of {each_smsg_done}
-       my $wcb = $self->{wcb} //= do { # first message
-               my %sig = $lei->atfork_child_wq($self);
-               @SIG{keys %sig} = values %sig; # not local
-               $lei->{dedupe}->prepare_dedupe;
-               $self->write_cb($lei);
-       };
-       my $git = $self->{"$$\0$git_dir"} //= PublicInbox::Git->new($git_dir);
-       $git->cat_async($oid, \&git_to_mail, [ $wcb, $kw, $not_done ]);
+sub poke_dst {
+       my ($self) = @_;
+       if ($self->{base_type} eq 'maildir') {
+               my $t = time + 1;
+               utime($t, $t, "$self->{dst}/cur");
+       }
 }
 
-sub ipc_atfork_prepare {
-       my ($self) = @_;
-       # (qry_status_wr, stdout|mbox, stderr, 3: sock, 4: each_smsg_done_wr)
-       $self->wq_set_recv_modes(qw[+<&= >&= >&= +<&= >&=]);
-       $self->SUPER::ipc_atfork_prepare; # PublicInbox::IPC
+sub write_mail { # via ->wq_io_do
+       my ($self, $git_dir, $smsg) = @_;
+       my $git = $self->{"$$\0$git_dir"} //= PublicInbox::Git->new($git_dir);
+       git_async_cat($git, $smsg->{blob}, \&git_to_mail,
+                               [$self->{wcb}, $smsg]);
 }
 
-sub DESTROY {
+sub wq_atexit_child {
        my ($self) = @_;
-       for my $pid_git (grep(/\A$$\0/, keys %$self)) {
-               $self->{$pid_git}->async_wait_all;
+       delete $self->{wcb};
+       for my $git (delete @$self{grep(/\A$$\0/, keys %$self)}) {
+               $git->async_wait_all;
        }
+       $SIG{__WARN__} = 'DEFAULT';
 }
 
 1;