# Copyright (C) all contributors
# License: AGPL-3.0+
# Extends read-only Inbox for writing
package PublicInbox::InboxWritable;
use strict;
use v5.10.1;
use parent qw(PublicInbox::Inbox PublicInbox::Umask Exporter);
use PublicInbox::Import;
use PublicInbox::IO qw(read_all);
use PublicInbox::Filter::Base qw(REJECT);
use Errno qw(ENOENT);
our @EXPORT_OK = qw(eml_from_path);
use Fcntl qw(O_RDONLY O_NONBLOCK);
sub new {
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;
my $mm = PublicInbox::Msgmap->new_file($self, 1);
if (defined $skip_artnum) {
$mm->{dbh}->begin_work;
$mm->skip_artnum($skip_artnum);
$mm->{dbh}->commit;
}
undef $mm; # ->created_at set
$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->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) = @_;
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, $im) = @_;
my $f = $self->{filter};
if ($f && $f =~ /::/) {
# 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+/;
eval "require $f";
if ($@) {
warn $@;
} else {
# e.g: PublicInbox::Filter::Vger->new(@args)
return $f->new(@args);
}
}
undef;
}
sub eml_from_path ($) {
my ($path) = @_;
if (sysopen(my $fh, $path, O_RDONLY|O_NONBLOCK)) {
return unless -f $fh && -s _; # no FIFOs or directories
PublicInbox::Eml->new(\(my $str = read_all($fh, -s _)));
} else { # ENOENT is common with Maildir
warn "failed to open $path: $!\n" if $! != ENOENT;
undef;
}
}
sub _each_maildir_eml {
my ($fn, $kw, $eml, $im, $self) = @_;
return if grep(/\Adraft\z/, @$kw);
if ($self && (my $filter = $self->filter($im))) {
my $ret = $filter->scrub($eml) or return;
return if $ret == REJECT();
$eml = $ret;
}
$im->add($eml);
}
# XXX does anybody use this?
sub import_maildir {
my ($self, $dir) = @_;
foreach my $sub (qw(cur new tmp)) {
-d "$dir/$sub" or die "$dir is not a Maildir (missing $sub)\n";
}
my $im = $self->importer(1);
my @self = $self->filter($im) ? ($self) : ();
require PublicInbox::MdirReader;
PublicInbox::MdirReader->new->maildir_each_eml($dir,
\&_each_maildir_eml, $im, @self);
$im->done;
}
sub _mbox_eml_cb { # MboxReader->mbox* callback
my ($eml, $im, $filter) = @_;
if ($filter) {
my $ret = $filter->scrub($eml) or return;
return if $ret == REJECT();
$eml = $ret;
}
$im->add($eml);
}
sub import_mbox {
my ($self, $fh, $variant) = @_;
require PublicInbox::MboxReader;
my $cb = PublicInbox::MboxReader->reads($variant) or
die "$variant not supported\n";
my $im = $self->importer(1);
$cb->(undef, $fh, \&_mbox_eml_cb, $im, $self->filter);
$im->done;
}
sub cleanup ($) {
delete @{$_[0]}{qw(over mm git search)};
}
# v2+ only, XXX: maybe we can just rely on ->max_git_epoch and remove
sub git_dir_latest {
my ($self, $max) = @_;
defined($$max = $self->max_git_epoch) ?
"$self->{inboxdir}/git/$$max.git" : undef;
}
# for unconfigured inboxes
sub detect_indexlevel ($) {
my ($ibx) = @_;
my $over = $ibx->over;
my $srch = $ibx->search;
delete @$ibx{qw(over search)}; # don't leave open FDs lying around
# brand new or never before indexed inboxes default to full
return 'full' unless $over;
my $l = 'basic';
return $l unless $srch;
if (my $xdb = $srch->xdb) {
$l = 'full';
my $m = $xdb->get_metadata('indexlevel');
if ($m eq 'medium') {
$l = $m;
} elsif ($m ne '') {
warn <<"";
$ibx->{inboxdir} has unexpected indexlevel in Xapian: $m
}
$ibx->{-skip_docdata} = 1 if $xdb->get_metadata('skip_docdata');
}
$l;
}
1;