1 # Copyright (C) 2019 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;
10 use base qw(Exporter);
11 our @EXPORT_OK = qw(resolve_repo_dir);
12 require PublicInbox::Config;
14 sub resolve_repo_dir {
16 my $prefix = defined $cd ? $cd : './';
17 if (-d $prefix && -f "$prefix/inbox.lock") { # v2
19 return abs_path($prefix);
22 my @cmd = qw(git rev-parse --git-dir);
23 my $cmd = join(' ', @cmd);
24 my $pid = open my $fh, '-|';
25 defined $pid or die "forking $cmd failed: $!\n";
28 chdir $cd or die "chdir $cd failed: $!\n";
31 die "Failed to exec $cmd: $!\n";
37 close $fh or die "error in $cmd (cwd:$cd): $!\n";
40 return abs_path($cd) if ($dir eq '.' && defined $cd);
45 # for unconfigured inboxes
46 sub detect_indexlevel ($) {
49 # brand new or never before indexed inboxes default to full
50 return 'full' unless $ibx->over;
51 delete $ibx->{over}; # don't leave open FD lying around
54 my $srch = $ibx->search or return $l;
55 delete $ibx->{search}; # don't leave open FD lying around
56 if (my $xdb = $srch->xdb) {
58 my $m = $xdb->get_metadata('indexlevel');
63 $ibx->{inboxdir} has unexpected indexlevel in Xapian: $m
70 sub unconfigured_ibx ($$) {
72 my $name = "unconfigured-$i";
73 PublicInbox::Inbox->new({
75 address => [ "$name\@example.com" ],
77 # TODO: consumers may want to warn on this:
82 sub resolve_inboxes ($;$$) {
83 my ($argv, $opt, $cfg) = @_;
84 require PublicInbox::Inbox;
87 $cfg //= eval { PublicInbox::Config->new };
89 my $cfgfile = PublicInbox::Config::default_file();
90 $cfg or die "--all specified, but $cfgfile not readable\n";
91 @$argv and die "--all specified, but directories specified\n";
94 my $min_ver = $opt->{-min_inbox_version} || 0;
98 $cfg->each_inbox(sub {
100 $ibx->{version} ||= 1;
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(Email::MIME 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";
203 my ($ibx, $im, $opt) = @_;
204 my $jobs = delete $opt->{jobs} if $opt;
205 if (ref($ibx) && ($ibx->{version} || 1) == 2) {
206 eval { require PublicInbox::V2Writable };
207 die "v2 requirements not met: $@\n" if $@;
208 my $v2w = $im // eval { $ibx->importer(0) } || eval {
209 PublicInbox::V2Writable->new($ibx, {nproc=>$jobs});
213 $v2w->{parallel} = 0;
215 my $n = $v2w->{shards};
216 if ($jobs != ($n + 1) && !$opt->{reshard}) {
218 "Unable to respect --jobs=$jobs, inbox was created with $n shards\n";
222 my $warn_cb = $SIG{__WARN__} || sub { print STDERR @_ };
223 local $SIG{__WARN__} = sub {
224 $warn_cb->($v2w->{current_info}, ': ', @_);
226 $v2w->index_sync($opt);
228 require PublicInbox::SearchIdx;
229 my $s = PublicInbox::SearchIdx->new($ibx, 1);
230 $s->index_sync($opt);
234 sub progress_prepare ($) {
237 # public-inbox-index defaults to quiet, -xcpdb and -compact do not
238 if (defined($opt->{quiet}) && $opt->{quiet} < 0) {
239 $opt->{quiet} = !$opt->{verbose};
242 open my $null, '>', '/dev/null' or
243 die "failed to open /dev/null: $!\n";
244 $opt->{1} = fileno($null); # suitable for spawn() redirect
245 $opt->{-dev_null} = $null;
247 $opt->{verbose} ||= 1;
248 $opt->{-progress} = sub { print STDERR @_ };