-# Copyright (C) 2018 all contributors <meta@public-inbox.org>
+# Copyright (C) 2018-2020 all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
# Extends read-only Inbox for writing
package PublicInbox::InboxWritable;
use strict;
-use warnings;
-use base qw(PublicInbox::Inbox);
+use v5.10.1;
+use parent qw(PublicInbox::Inbox Exporter);
use PublicInbox::Import;
-use PublicInbox::Filter::Base;
-*REJECT = *PublicInbox::Filter::Base::REJECT;
+use PublicInbox::Filter::Base qw(REJECT);
+use Errno qw(ENOENT);
+our @EXPORT_OK = qw(eml_from_path warn_ignore_cb);
use constant {
PERM_UMASK => 0,
};
sub new {
- my ($class, $ibx) = @_;
- bless $ibx, $class;
+ my ($class, $ibx, $creat_opt) = @_;
+ return $ibx if ref($ibx) eq $class;
+ my $self = bless $ibx, $class;
+
+ # TODO: maybe stop supporting this
+ if ($creat_opt) { # for { nproc => $N }
+ $self->{-creat_opt} = $creat_opt;
+ init_inbox($self) if $self->version == 1;
+ }
+ $self;
+}
+
+sub assert_usable_dir {
+ my ($self) = @_;
+ my $dir = $self->{inboxdir};
+ return $dir if defined($dir) && $dir ne '';
+ die "no inboxdir defined for $self->{name}\n";
+}
+
+sub _init_v1 {
+ my ($self, $skip_artnum) = @_;
+ if (defined($self->{indexlevel}) || defined($skip_artnum)) {
+ require PublicInbox::SearchIdx;
+ require PublicInbox::Msgmap;
+ my $sidx = PublicInbox::SearchIdx->new($self, 1); # just create
+ $sidx->begin_txn_lazy;
+ if (defined $skip_artnum) {
+ my $mm = PublicInbox::Msgmap->new($self->{inboxdir}, 1);
+ $mm->{dbh}->begin_work;
+ $mm->skip_artnum($skip_artnum);
+ $mm->{dbh}->commit;
+ }
+ $sidx->commit_txn_lazy;
+ } else {
+ open my $fh, '>>', "$self->{inboxdir}/ssoma.lock" or
+ die "$self->{inboxdir}/ssoma.lock: $!\n";
+ }
+}
+
+sub init_inbox {
+ my ($self, $shards, $skip_epoch, $skip_artnum) = @_;
+ if ($self->version == 1) {
+ my $dir = assert_usable_dir($self);
+ PublicInbox::Import::init_bare($dir);
+ $self->umask_prepare;
+ $self->with_umask(\&_init_v1, $self, $skip_artnum);
+ } else {
+ my $v2w = importer($self);
+ $v2w->init_inbox($shards, $skip_epoch, $skip_artnum);
+ }
}
sub importer {
my ($self, $parallel) = @_;
- $self->{-importer} ||= eval {
- my $v = $self->{version} || 1;
- if ($v == 2) {
- eval { require PublicInbox::V2Writable };
- die "v2 not supported: $@\n" if $@;
- my $v2w = PublicInbox::V2Writable->new($self);
- $v2w->{parallel} = $parallel;
- $v2w;
- } elsif ($v == 1) {
- my $git = $self->git;
- my $name = $self->{name};
- my $addr = $self->{-primary_address};
- PublicInbox::Import->new($git, $name, $addr, $self);
- } else {
- $! = 78; # EX_CONFIG 5.3.5 local configuration error
- die "unsupported inbox version: $v\n";
- }
+ my $v = $self->version;
+ if ($v == 2) {
+ eval { require PublicInbox::V2Writable };
+ die "v2 not supported: $@\n" if $@;
+ my $opt = $self->{-creat_opt};
+ my $v2w = PublicInbox::V2Writable->new($self, $opt);
+ $v2w->{parallel} = $parallel if defined $parallel;
+ $v2w;
+ } elsif ($v == 1) {
+ my @arg = (undef, undef, undef, $self);
+ PublicInbox::Import->new(@arg);
+ } else {
+ $! = 78; # EX_CONFIG 5.3.5 local configuration error
+ die "unsupported inbox version: $v\n";
}
}
sub filter {
- my ($self) = @_;
+ my ($self, $im) = @_;
my $f = $self->{filter};
if ($f && $f =~ /::/) {
- my @args = (-inbox => $self);
+ # v2 keeps msgmap open, which causes conflicts for filters
+ # such as PublicInbox::Filter::RubyLang which overload msgmap
+ # for a predictable serial number.
+ if ($im && $self->version >= 2 && $self->{altid}) {
+ $im->done;
+ }
+
+ my @args = (ibx => $self);
# basic line splitting, only
# Perhaps we can have proper quote splitting one day...
($f, @args) = split(/\s+/, $f) if $f =~ /\s+/;
(is_maildir_basename($p[-1]) && -f $path) ? 1 : 0;
}
-sub maildir_path_load ($) {
+sub eml_from_path ($) {
my ($path) = @_;
if (open my $fh, '<', $path) {
- local $/;
- my $str = <$fh>;
- $str or return;
- return PublicInbox::MIME->new(\$str);
- } elsif ($!{ENOENT}) {
- # common with Maildir
- return;
- } else {
- warn "failed to open $path: $!\n";
- return;
+ my $str = do { local $/; <$fh> } or return;
+ PublicInbox::Eml->new(\$str);
+ } else { # ENOENT is common with Maildir
+ warn "failed to open $path: $!\n" if $! != ENOENT;
+ undef;
}
}
sub import_maildir {
my ($self, $dir) = @_;
my $im = $self->importer(1);
- my $filter = $self->filter;
+
foreach my $sub (qw(cur new tmp)) {
-d "$dir/$sub" or die "$dir is not a Maildir (missing $sub)\n";
}
opendir my $dh, "$dir/$sub" or die "opendir $dir/$sub: $!\n";
while (defined(my $fn = readdir($dh))) {
next unless is_maildir_basename($fn);
- my $mime = maildir_file_load("$dir/$fn") or next;
- if ($filter) {
+ my $mime = eml_from_path("$dir/$fn") or next;
+
+ if (my $filter = $self->filter($im)) {
my $ret = $filter->scrub($mime) or return;
return if $ret == REJECT();
$mime = $ret;
sub mb_add ($$$$) {
my ($im, $variant, $filter, $msg) = @_;
$$msg =~ s/(\r?\n)+\z/$1/s;
- my $mime = PublicInbox::MIME->new($msg);
if ($variant eq 'mboxrd') {
- $$msg =~ s/^>(>*From )/$1/sm;
+ $$msg =~ s/^>(>*From )/$1/gms;
} elsif ($variant eq 'mboxo') {
- $$msg =~ s/^>From /From /sm;
+ $$msg =~ s/^>From /From /gms;
}
+ my $mime = PublicInbox::Eml->new($msg);
if ($filter) {
my $ret = $filter->scrub($mime) or return;
return if $ret == REJECT();
}
sub with_umask {
- my ($self, $cb) = @_;
+ my ($self, $cb, @arg) = @_;
my $old = umask $self->{umask};
- my $rv = eval { $cb->() };
+ my $rv = eval { $cb->(@arg) };
my $err = $@;
umask $old;
die $err if $err;
$self->{umask} = $umask;
}
+sub cleanup ($) {
+ delete @{$_[0]}{qw(over mm git search)};
+}
+
+# warnings to ignore when handling spam mailboxes and maybe other places
+sub warn_ignore {
+ my $s = "@_";
+ # Email::Address::XS warnings
+ $s =~ /^Argument contains empty address at /
+ || $s =~ /^Element at index [0-9]+ contains /
+ # PublicInbox::MsgTime
+ || $s =~ /^bogus TZ offset: .+?, ignoring and assuming \+0000/
+ || $s =~ /^bad Date: .+? in /
+}
+
+# this expects to be RHS in this assignment: "local $SIG{__WARN__} = ..."
+sub warn_ignore_cb {
+ my $cb = $SIG{__WARN__} // sub { print STDERR @_ };
+ sub {
+ return if warn_ignore(@_);
+ $cb->(@_);
+ }
+}
+
+# v2+ only
+sub git_dir_n { "$_[0]->{inboxdir}/git/$_[1].git" }
+
+# v2+ only
+sub git_dir_latest {
+ my ($self, $max) = @_;
+ $$max = -1;
+ my $pfx = "$self->{inboxdir}/git";
+ return unless -d $pfx;
+ my $latest;
+ opendir my $dh, $pfx or die "opendir $pfx: $!\n";
+ while (defined(my $git_dir = readdir($dh))) {
+ $git_dir =~ m!\A([0-9]+)\.git\z! or next;
+ if ($1 > $$max) {
+ $$max = $1;
+ $latest = "$pfx/$git_dir";
+ }
+ }
+ $latest;
+}
+
1;