-# Copyright (C) 2019 all contributors <meta@public-inbox.org>
+# Copyright (C) 2019-2020 all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
# common stuff for administrative command-line tools
# Unstable internal API
package PublicInbox::Admin;
use strict;
-use warnings;
-use Cwd 'abs_path';
-use base qw(Exporter);
-our @EXPORT_OK = qw(resolve_repo_dir);
+use parent qw(Exporter);
+use Cwd qw(abs_path);
+use POSIX ();
+our @EXPORT_OK = qw(resolve_repo_dir setup_signals);
+use PublicInbox::Config;
+use PublicInbox::Inbox;
+use PublicInbox::Spawn qw(popen_rd);
+
+sub setup_signals {
+ my ($cb, $arg) = @_; # optional
+
+ # we call exit() here instead of _exit() so DESTROY methods
+ # get called (e.g. File::Temp::Dir and PublicInbox::Msgmap)
+ $SIG{INT} = $SIG{HUP} = $SIG{PIPE} = $SIG{TERM} = sub {
+ my ($sig) = @_;
+ # https://www.tldp.org/LDP/abs/html/exitcodes.html
+ eval { $cb->($sig, $arg) } if $cb;
+ $sig = 'SIG'.$sig;
+ exit(128 + POSIX->$sig);
+ };
+}
sub resolve_repo_dir {
my ($cd, $ver) = @_;
$$ver = 2 if $ver;
return abs_path($prefix);
}
-
- my @cmd = qw(git rev-parse --git-dir);
- my $cmd = join(' ', @cmd);
- my $pid = open my $fh, '-|';
- defined $pid or die "forking $cmd failed: $!\n";
- if ($pid == 0) {
- if (defined $cd) {
- chdir $cd or die "chdir $cd failed: $!\n";
- }
- exec @cmd;
- die "Failed to exec $cmd: $!\n";
- } else {
- my $dir = eval {
- local $/;
- <$fh>;
- };
- close $fh or die "error in $cmd: $!\n";
- chomp $dir;
- $$ver = 1 if $ver;
- return abs_path($cd) if ($dir eq '.' && defined $cd);
- abs_path($dir);
- }
+ my $cmd = [ qw(git rev-parse --git-dir) ];
+ my $fh = popen_rd($cmd, undef, {-C => $cd});
+ my $dir = do { local $/; <$fh> };
+ close $fh or die "error in ".join(' ', @$cmd)." (cwd:$cd): $!\n";
+ chomp $dir;
+ $$ver = 1 if $ver;
+ return abs_path($cd) if ($dir eq '.' && defined $cd);
+ abs_path($dir);
}
# for unconfigured inboxes
sub detect_indexlevel ($) {
my ($ibx) = @_;
- # brand new or never before indexed inboxes default to full
- return 'full' unless $ibx->over;
- delete $ibx->{over}; # don't leave open FD lying around
+ 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';
- my $srch = $ibx->search or return $l;
- delete $ibx->{search}; # don't leave open FD lying around
+ return $l unless $srch;
if (my $xdb = $srch->xdb) {
$l = 'full';
my $m = $xdb->get_metadata('indexlevel');
$l = $m;
} elsif ($m ne '') {
warn <<"";
-$ibx->{mainrepo} has unexpected indexlevel in Xapian: $m
+$ibx->{inboxdir} has unexpected indexlevel in Xapian: $m
}
+ $ibx->{-skip_docdata} = 1 if $xdb->get_metadata('skip_docdata');
}
$l;
}
-sub resolve_inboxes {
- my ($argv) = @_;
- require PublicInbox::Config;
- require PublicInbox::Inbox;
+sub unconfigured_ibx ($$) {
+ my ($dir, $i) = @_;
+ my $name = "unconfigured-$i";
+ PublicInbox::Inbox->new({
+ name => $name,
+ address => [ "$name\@example.com" ],
+ inboxdir => $dir,
+ # TODO: consumers may want to warn on this:
+ #-unconfigured => 1,
+ });
+}
+
+sub resolve_inboxes ($;$$) {
+ my ($argv, $opt, $cfg) = @_;
+ $opt ||= {};
- my @ibxs = map { resolve_repo_dir($_) } @$argv;
- push(@ibxs, resolve_repo_dir()) unless @ibxs;
+ $cfg //= PublicInbox::Config->new;
+ if ($opt->{all}) {
+ my $cfgfile = PublicInbox::Config::default_file();
+ $cfg or die "--all specified, but $cfgfile not readable\n";
+ @$argv and die "--all specified, but directories specified\n";
+ }
+ my $min_ver = $opt->{-min_inbox_version} || 0;
+ my (@old, @ibxs);
my %dir2ibx;
- if (my $config = eval { PublicInbox::Config->new }) {
- $config->each_inbox(sub {
+ if ($cfg) {
+ $cfg->each_inbox(sub {
my ($ibx) = @_;
- $dir2ibx{abs_path($ibx->{mainrepo})} = $ibx;
+ my $path = abs_path($ibx->{inboxdir});
+ if (defined($path)) {
+ $dir2ibx{$path} = $ibx;
+ } else {
+ warn <<EOF;
+W: $ibx->{name} $ibx->{inboxdir}: $!
+EOF
+ }
});
}
- for my $i (0..$#ibxs) {
- my $dir = $ibxs[$i];
- $ibxs[$i] = $dir2ibx{$dir} ||= do {
- my $name = "unconfigured-$i";
- PublicInbox::Inbox->new({
- name => $name,
- address => [ "$name\@example.com" ],
- mainrepo => $dir,
- # TODO: consumers may want to warn on this:
- #-unconfigured => 1,
- });
- };
+ if ($opt->{all}) {
+ my @all = values %dir2ibx;
+ @all = grep { $_->version >= $min_ver } @all;
+ push @ibxs, @all;
+ } else { # directories specified on the command-line
+ my $i = 0;
+ my @dirs = @$argv;
+ push @dirs, '.' unless @dirs;
+ foreach (@dirs) {
+ my $v;
+ my $dir = resolve_repo_dir($_, \$v);
+ if ($v < $min_ver) {
+ push @old, $dir;
+ next;
+ }
+ my $ibx = $dir2ibx{$dir} ||= unconfigured_ibx($dir, $i);
+ $i++;
+ push @ibxs, $ibx;
+ }
+ }
+ if (@old) {
+ die "-V$min_ver inboxes not supported by $0\n\t",
+ join("\n\t", @old), "\n";
}
@ibxs;
}
# TODO: make Devel::Peek optional, only used for daemon
-my @base_mod = qw(Email::MIME Date::Parse Devel::Peek);
+my @base_mod = qw(Devel::Peek);
my @over_mod = qw(DBD::SQLite DBI);
my %mod_groups = (
-index => [ @base_mod, @over_mod ],
while (my $mod = shift @mods) {
if (my $groups = $mod_groups{$mod}) {
push @mods, @$groups;
+ } elsif ($mod eq 'Search::Xapian') {
+ require PublicInbox::Search;
+ PublicInbox::Search::load_xapian() or
+ $err->{'Search::Xapian || Xapian'} = $@;
} else {
eval "require $mod";
$err->{$mod} = $@ if $@;
die missing_mod_msg($err) ." required for indexlevel=$indexlevel\n";
}
+sub index_terminate {
+ my (undef, $ibx) = @_; # $_[0] = signal name
+ $ibx->git->cleanup;
+}
+
sub index_inbox {
- my ($ibx, $opt) = @_;
+ my ($ibx, $im, $opt) = @_;
my $jobs = delete $opt->{jobs} if $opt;
- if (ref($ibx) && ($ibx->{version} || 1) == 2) {
+ if (my $pr = $opt->{-progress}) {
+ $pr->("indexing $ibx->{inboxdir} ...\n");
+ }
+ local %SIG = %SIG;
+ setup_signals(\&index_terminate, $ibx);
+ if (ref($ibx) && $ibx->version == 2) {
eval { require PublicInbox::V2Writable };
die "v2 requirements not met: $@\n" if $@;
- my $v2w = eval { $ibx->importer(0) } || eval {
- PublicInbox::V2Writable->new($ibx, {nproc=>$jobs});
- };
+ $ibx->{-creat_opt}->{nproc} = $jobs;
+ my $v2w = $im // $ibx->importer($opt->{reindex} // $jobs);
if (defined $jobs) {
if ($jobs == 0) {
$v2w->{parallel} = 0;
} else {
- my $n = $v2w->{partitions};
- if ($jobs != ($n + 1)) {
+ my $n = $v2w->{shards};
+ if ($jobs < ($n + 1) && !$opt->{reshard}) {
warn
-"Unable to respect --jobs=$jobs, inbox was created with $n partitions\n";
+"Unable to respect --jobs=$jobs on index, inbox was created with $n shards\n";
}
}
}
if ($opt->{quiet}) {
open my $null, '>', '/dev/null' or
die "failed to open /dev/null: $!\n";
- $opt->{1} = fileno($null); # suitable for spawn() redirect
- $opt->{-dev_null} = $null;
+ $opt->{1} = $null; # suitable for spawn() redirect
} else {
$opt->{verbose} ||= 1;
$opt->{-progress} = sub { print STDERR @_ };
}
}
+# same unit factors as git:
+sub parse_unsigned ($) {
+ my ($val) = @_;
+
+ $$val =~ /\A([0-9]+)([kmg])?\z/i or return;
+ my ($n, $unit_factor) = ($1, $2 // '');
+ my %u = ( k => 1024, m => 1024**2, g => 1024**3 );
+ $$val = $n * ($u{lc($unit_factor)} // 1);
+ 1;
+}
+
+sub index_prepare ($$) {
+ my ($opt, $cfg) = @_;
+ my $env;
+ if ($opt->{compact}) {
+ require PublicInbox::Xapcmd;
+ PublicInbox::Xapcmd::check_compact();
+ $opt->{compact_opt} = { -coarse_lock => 1, compact => 1 };
+ if (defined(my $jobs = $opt->{jobs})) {
+ $opt->{compact_opt}->{jobs} = $jobs;
+ }
+ }
+ for my $k (qw(max_size batch_size)) {
+ my $git_key = "publicInbox.index".ucfirst($k);
+ $git_key =~ s/_([a-z])/\U$1/g;
+ defined(my $v = $opt->{$k} // $cfg->{lc($git_key)}) or next;
+ parse_unsigned(\$v) or die "`$git_key=$v' not parsed\n";
+ $v > 0 or die "`$git_key=$v' must be positive\n";
+ $opt->{$k} = $v;
+ }
+
+ # out-of-the-box builds of Xapian 1.4.x are still limited to 32-bit
+ # https://getting-started-with-xapian.readthedocs.io/en/latest/concepts/indexing/limitations.html
+ $opt->{batch_size} and
+ $env = { XAPIAN_FLUSH_THRESHOLD => '4294967295' };
+
+ for my $k (qw(sequential_shard)) {
+ my $git_key = "publicInbox.index".ucfirst($k);
+ $git_key =~ s/_([a-z])/\U$1/g;
+ defined(my $s = $opt->{$k} // $cfg->{lc($git_key)}) or next;
+ defined(my $v = $cfg->git_bool($s))
+ or die "`$git_key=$s' not boolean\n";
+ $opt->{$k} = $v;
+ }
+ $env;
+}
+
1;