# Copyright (C) 2018-2020 all contributors
# License: AGPL-3.0+
# Extends read-only Inbox for writing
package PublicInbox::InboxWritable;
use strict;
use warnings;
use base qw(PublicInbox::Inbox);
use PublicInbox::Import;
use PublicInbox::Filter::Base qw(REJECT);
use constant {
PERM_UMASK => 0,
OLD_PERM_GROUP => 1,
OLD_PERM_EVERYBODY => 2,
PERM_GROUP => 0660,
PERM_EVERYBODY => 0664,
};
sub new {
my ($class, $ibx, $creat_opt) = @_;
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_inbox {
my ($self, $shards, $skip_epoch, $skip_artnum) = @_;
# TODO: honor skip_artnum
if ($self->version == 1) {
my $dir = assert_usable_dir($self);
PublicInbox::Import::init_bare($dir);
} 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;
$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 = (-inbox => $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 is_maildir_basename ($) {
my ($bn) = @_;
return 0 if $bn !~ /\A[a-zA-Z0-9][\-\w:,=\.]+\z/;
if ($bn =~ /:2,([A-Z]+)\z/i) {
my $flags = $1;
return 0 if $flags =~ /[DT]/; # no [D]rafts or [T]rashed mail
}
1;
}
sub is_maildir_path ($) {
my ($path) = @_;
my @p = split(m!/+!, $path);
(is_maildir_basename($p[-1]) && -f $path) ? 1 : 0;
}
sub maildir_path_load ($) {
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;
}
}
sub import_maildir {
my ($self, $dir) = @_;
my $im = $self->importer(1);
foreach my $sub (qw(cur new tmp)) {
-d "$dir/$sub" or die "$dir is not a Maildir (missing $sub)\n";
}
foreach my $sub (qw(cur new)) {
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_path_load("$dir/$fn") or next;
if (my $filter = $self->filter($im)) {
my $ret = $filter->scrub($mime) or return;
return if $ret == REJECT();
$mime = $ret;
}
$im->add($mime);
}
}
$im->done;
}
# asctime: From example@example.com Fri Jun 23 02:56:55 2000
my $from_strict = qr/^From \S+ +\S+ \S+ +\S+ [^:]+:[^:]+:[^:]+ [^:]+/;
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;
} elsif ($variant eq 'mboxo') {
$$msg =~ s/^>From /From /sm;
}
if ($filter) {
my $ret = $filter->scrub($mime) or return;
return if $ret == REJECT();
$mime = $ret;
}
$im->add($mime)
}
sub import_mbox {
my ($self, $fh, $variant) = @_;
if ($variant !~ /\A(?:mboxrd|mboxo)\z/) {
die "variant must be 'mboxrd' or 'mboxo'\n";
}
my $im = $self->importer(1);
my $prev = undef;
my $msg = '';
my $filter = $self->filter;
while (defined(my $l = <$fh>)) {
if ($l =~ /$from_strict/o) {
if (!defined($prev) || $prev =~ /^\r?$/) {
mb_add($im, $variant, $filter, \$msg) if $msg;
$msg = '';
$prev = $l;
next;
}
warn "W[$.] $l\n";
}
$prev = $l;
$msg .= $l;
}
mb_add($im, $variant, $filter, \$msg) if $msg;
$im->done;
}
sub _read_git_config_perm {
my ($self) = @_;
chomp(my $perm = $self->git->qx('config', 'core.sharedRepository'));
$perm;
}
sub _git_config_perm {
my $self = shift;
my $perm = scalar @_ ? $_[0] : _read_git_config_perm($self);
return PERM_UMASK if (!defined($perm) || $perm eq '');
return PERM_UMASK if ($perm eq 'umask');
return PERM_GROUP if ($perm eq 'group');
if ($perm =~ /\A(?:all|world|everybody)\z/) {
return PERM_EVERYBODY;
}
return PERM_GROUP if ($perm =~ /\A(?:true|yes|on|1)\z/);
return PERM_UMASK if ($perm =~ /\A(?:false|no|off|0)\z/);
my $i = oct($perm);
return PERM_UMASK if ($i == PERM_UMASK);
return PERM_GROUP if ($i == OLD_PERM_GROUP);
return PERM_EVERYBODY if ($i == OLD_PERM_EVERYBODY);
if (($i & 0600) != 0600) {
die "core.sharedRepository mode invalid: ".
sprintf('%.3o', $i) . "\nOwner must have permissions\n";
}
($i & 0666);
}
sub _umask_for {
my ($perm) = @_; # _git_config_perm return value
my $rv = $perm;
return umask if $rv == 0;
# set +x bit if +r or +w were set
$rv |= 0100 if ($rv & 0600);
$rv |= 0010 if ($rv & 0060);
$rv |= 0001 if ($rv & 0006);
(~$rv & 0777);
}
sub with_umask {
my ($self, $cb) = @_;
my $old = umask $self->{umask};
my $rv = eval { $cb->() };
my $err = $@;
umask $old;
die $err if $err;
$rv;
}
sub umask_prepare {
my ($self) = @_;
my $perm = _git_config_perm($self);
my $umask = _umask_for($perm);
$self->{umask} = $umask;
}
sub cleanup ($) {
delete @{$_[0]}{qw(over mm git search)};
}
1;