1 # Copyright (C) 2019-2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # common stuff for administrative command-line tools
5 # Unstable internal API
6 package PublicInbox::Admin;
8 use parent qw(Exporter);
11 our @EXPORT_OK = qw(resolve_repo_dir setup_signals);
12 use PublicInbox::Config;
13 use PublicInbox::Inbox;
14 use PublicInbox::Spawn qw(popen_rd);
17 my ($cb, $arg) = @_; # optional
19 # we call exit() here instead of _exit() so DESTROY methods
20 # get called (e.g. File::Temp::Dir and PublicInbox::Msgmap)
21 $SIG{INT} = $SIG{HUP} = $SIG{PIPE} = $SIG{TERM} = sub {
23 # https://www.tldp.org/LDP/abs/html/exitcodes.html
24 eval { $cb->($sig, $arg) } if $cb;
26 exit(128 + POSIX->$sig);
30 sub resolve_repo_dir {
32 my $prefix = defined $cd ? $cd : './';
33 if (-d $prefix && -f "$prefix/inbox.lock") { # v2
35 return abs_path($prefix);
37 my $cmd = [ qw(git rev-parse --git-dir) ];
38 my $fh = popen_rd($cmd, undef, {-C => $cd});
39 my $dir = do { local $/; <$fh> };
40 close $fh or die "error in ".join(' ', @$cmd)." (cwd:$cd): $!\n";
43 return abs_path($cd) if ($dir eq '.' && defined $cd);
47 # for unconfigured inboxes
48 sub detect_indexlevel ($) {
51 # brand new or never before indexed inboxes default to full
52 return 'full' unless $ibx->over;
53 delete $ibx->{over}; # don't leave open FD lying around
56 my $srch = $ibx->search or return $l;
57 delete $ibx->{search}; # don't leave open FD lying around
58 if (my $xdb = $srch->xdb) {
60 my $m = $xdb->get_metadata('indexlevel');
65 $ibx->{inboxdir} has unexpected indexlevel in Xapian: $m
72 sub unconfigured_ibx ($$) {
74 my $name = "unconfigured-$i";
75 PublicInbox::Inbox->new({
77 address => [ "$name\@example.com" ],
79 # TODO: consumers may want to warn on this:
84 sub resolve_inboxes ($;$$) {
85 my ($argv, $opt, $cfg) = @_;
88 $cfg //= PublicInbox::Config->new;
90 my $cfgfile = PublicInbox::Config::default_file();
91 $cfg or die "--all specified, but $cfgfile not readable\n";
92 @$argv and die "--all specified, but directories specified\n";
95 my $min_ver = $opt->{-min_inbox_version} || 0;
99 $cfg->each_inbox(sub {
101 my $path = abs_path($ibx->{inboxdir});
102 if (defined($path)) {
103 $dir2ibx{$path} = $ibx;
106 W: $ibx->{name} $ibx->{inboxdir}: $!
112 my @all = values %dir2ibx;
113 @all = grep { $_->version >= $min_ver } @all;
115 } else { # directories specified on the command-line
118 push @dirs, '.' unless @dirs;
121 my $dir = resolve_repo_dir($_, \$v);
126 my $ibx = $dir2ibx{$dir} ||= unconfigured_ibx($dir, $i);
132 die "inboxes $min_ver inboxes not supported by $0\n\t",
133 join("\n\t", @old), "\n";
138 # TODO: make Devel::Peek optional, only used for daemon
139 my @base_mod = qw(Devel::Peek);
140 my @over_mod = qw(DBD::SQLite DBI);
142 -index => [ @base_mod, @over_mod ],
144 -search => [ @base_mod, @over_mod, 'Search::Xapian' ],
147 sub scan_ibx_modules ($$) {
148 my ($mods, $ibx) = @_;
149 if (!$ibx->{indexlevel} || $ibx->{indexlevel} ne 'basic') {
150 $mods->{'Search::Xapian'} = 1;
152 $mods->{$_} = 1 foreach @over_mod;
159 while (my $mod = shift @mods) {
160 if (my $groups = $mod_groups{$mod}) {
161 push @mods, @$groups;
162 } elsif ($mod eq 'Search::Xapian') {
163 require PublicInbox::Search;
164 PublicInbox::Search::load_xapian() or
165 $err->{'Search::Xapian || Xapian'} = $@;
168 $err->{$mod} = $@ if $@;
171 scalar keys %$err ? $err : undef;
174 sub missing_mod_msg {
176 my @mods = map { "`$_'" } sort keys %$err;
177 my $last = pop @mods;
178 @mods ? (join(', ', @mods)."' and $last") : $last
182 my $err = check_require(@_) or return;
183 die missing_mod_msg($err)." required for $0\n";
186 sub indexlevel_ok_or_die ($) {
187 my ($indexlevel) = @_;
189 if ($indexlevel eq 'basic') {
191 } elsif ($indexlevel =~ /\A(?:medium|full)\z/) {
195 invalid indexlevel=$indexlevel (must be `basic', `medium', or `full')
198 my $err = check_require($req) or return;
199 die missing_mod_msg($err) ." required for indexlevel=$indexlevel\n";
202 sub index_terminate {
203 my (undef, $ibx) = @_; # $_[0] = signal name
208 my ($ibx, $im, $opt) = @_;
209 my $jobs = delete $opt->{jobs} if $opt;
210 if (my $pr = $opt->{-progress}) {
211 $pr->("indexing $ibx->{inboxdir} ...\n");
214 setup_signals(\&index_terminate, $ibx);
215 if (ref($ibx) && $ibx->version == 2) {
216 eval { require PublicInbox::V2Writable };
217 die "v2 requirements not met: $@\n" if $@;
218 $ibx->{-creat_opt}->{nproc} = $jobs;
219 my $v2w = $im // $ibx->importer($opt->{reindex} // $jobs);
222 $v2w->{parallel} = 0;
224 my $n = $v2w->{shards};
225 if ($jobs < ($n + 1) && !$opt->{reshard}) {
227 "Unable to respect --jobs=$jobs on index, inbox was created with $n shards\n";
231 my $warn_cb = $SIG{__WARN__} || sub { print STDERR @_ };
232 local $SIG{__WARN__} = sub {
233 $warn_cb->($v2w->{current_info}, ': ', @_);
235 $v2w->index_sync($opt);
237 require PublicInbox::SearchIdx;
238 my $s = PublicInbox::SearchIdx->new($ibx, 1);
239 $s->index_sync($opt);
243 sub progress_prepare ($) {
246 # public-inbox-index defaults to quiet, -xcpdb and -compact do not
247 if (defined($opt->{quiet}) && $opt->{quiet} < 0) {
248 $opt->{quiet} = !$opt->{verbose};
251 open my $null, '>', '/dev/null' or
252 die "failed to open /dev/null: $!\n";
253 $opt->{1} = $null; # suitable for spawn() redirect
255 $opt->{verbose} ||= 1;
256 $opt->{-progress} = sub { print STDERR @_ };
260 # same unit factors as git:
261 sub parse_unsigned ($) {
264 $$val =~ /\A([0-9]+)([kmg])?\z/i or return;
265 my ($n, $unit_factor) = ($1, $2 // '');
266 my %u = ( k => 1024, m => 1024**2, g => 1024**3 );
267 $$val = $n * ($u{lc($unit_factor)} // 1);
271 sub index_prepare ($$) {
272 my ($opt, $cfg) = @_;
274 if ($opt->{compact}) {
275 require PublicInbox::Xapcmd;
276 PublicInbox::Xapcmd::check_compact();
277 $opt->{compact_opt} = { -coarse_lock => 1, compact => 1 };
278 if (defined(my $jobs = $opt->{jobs})) {
279 $opt->{compact_opt}->{jobs} = $jobs;
282 for my $k (qw(max_size batch_size)) {
283 my $git_key = "publicInbox.index".ucfirst($k);
284 $git_key =~ s/_([a-z])/\U$1/g;
285 defined(my $v = $opt->{$k} // $cfg->{lc($git_key)}) or next;
286 parse_unsigned(\$v) or die "`$git_key=$v' not parsed\n";
287 $v > 0 or die "`$git_key=$v' must be positive\n";
291 # out-of-the-box builds of Xapian 1.4.x are still limited to 32-bit
292 # https://getting-started-with-xapian.readthedocs.io/en/latest/concepts/indexing/limitations.html
293 $opt->{batch_size} and
294 $env = { XAPIAN_FLUSH_THRESHOLD => '4294967295' };
296 for my $k (qw(sequential_shard)) {
297 my $git_key = "publicInbox.index".ucfirst($k);
298 $git_key =~ s/_([a-z])/\U$1/g;
299 defined(my $s = $opt->{$k} // $cfg->{lc($git_key)}) or next;
300 defined(my $v = $cfg->git_bool($s))
301 or die "`$git_key=$s' not boolean\n";