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);
13 sub resolve_repo_dir {
15 my $prefix = defined $cd ? $cd : './';
16 if (-d $prefix && -f "$prefix/inbox.lock") { # v2
18 return abs_path($prefix);
21 my @cmd = qw(git rev-parse --git-dir);
22 my $cmd = join(' ', @cmd);
23 my $pid = open my $fh, '-|';
24 defined $pid or die "forking $cmd failed: $!\n";
27 chdir $cd or die "chdir $cd failed: $!\n";
30 die "Failed to exec $cmd: $!\n";
36 close $fh or die "error in $cmd: $!\n";
39 return abs_path($cd) if ($dir eq '.' && defined $cd);
45 my ($argv, $warn_on_unconfigured) = @_;
46 require PublicInbox::Config;
47 require PublicInbox::Inbox;
49 my @ibxs = map { resolve_repo_dir($_) } @$argv;
50 push(@ibxs, resolve_repo_dir()) unless @ibxs;
53 if (my $config = eval { PublicInbox::Config->new }) {
54 $config->each_inbox(sub {
56 $dir2ibx{abs_path($ibx->{mainrepo})} = $ibx;
58 } elsif ($warn_on_unconfigured) {
59 # do we really care about this? It's annoying...
60 warn $warn_on_unconfigured, "\n";
62 for my $i (0..$#ibxs) {
64 $ibxs[$i] = $dir2ibx{$dir} ||= do {
65 my $name = "unconfigured-$i";
66 PublicInbox::Inbox->new({
68 address => [ "$name\@example.com" ],
70 # TODO: consumers may want to warn on this:
78 # TODO: make Devel::Peek optional, only used for daemon
79 my @base_mod = qw(Email::MIME Date::Parse Devel::Peek);
80 my @over_mod = qw(DBD::SQLite DBI);
82 -index => [ @base_mod, @over_mod ],
84 -search => [ @base_mod, @over_mod, 'Search::Xapian' ],
87 sub scan_ibx_modules ($$) {
88 my ($mods, $ibx) = @_;
89 if (!$ibx->{indexlevel} || $ibx->{indexlevel} ne 'basic') {
90 $mods->{'Search::Xapian'} = 1;
92 $mods->{$_} = 1 foreach @over_mod;
99 while (my $mod = shift @mods) {
100 if (my $groups = $mod_groups{$mod}) {
101 push @mods, @$groups;
104 $err->{$mod} = $@ if $@;
107 scalar keys %$err ? $err : undef;
110 sub missing_mod_msg {
112 my @mods = map { "`$_'" } sort keys %$err;
113 my $last = pop @mods;
114 @mods ? (join(', ', @mods)."' and $last") : $last
118 my $err = check_require(@_) or return;
119 die missing_mod_msg($err)." required for $0\n";
122 sub indexlevel_ok_or_die ($) {
123 my ($indexlevel) = @_;
125 if ($indexlevel eq 'basic') {
127 } elsif ($indexlevel =~ /\A(?:medium|full)\z/) {
131 invalid indexlevel=$indexlevel (must be `basic', `medium', or `full')
134 my $err = check_require($req) or return;
135 die missing_mod_msg($err) ." required for indexlevel=$indexlevel\n";
139 my ($ibx, $opt) = @_;
140 my $jobs = delete $opt->{jobs} if $opt;
141 if (ref($ibx) && ($ibx->{version} || 1) == 2) {
142 eval { require PublicInbox::V2Writable };
143 die "v2 requirements not met: $@\n" if $@;
144 my $v2w = eval { $ibx->importer(0) } || eval {
145 PublicInbox::V2Writable->new($ibx, {nproc=>$jobs});
149 $v2w->{parallel} = 0;
151 my $n = $v2w->{partitions};
152 if ($jobs != ($n + 1)) {
154 "Unable to respect --jobs=$jobs, inbox was created with $n partitions\n";
158 my $warn_cb = $SIG{__WARN__} || sub { print STDERR @_ };
159 local $SIG{__WARN__} = sub {
160 $warn_cb->($v2w->{current_info}, ': ', @_);
162 $v2w->index_sync($opt);
164 require PublicInbox::SearchIdx;
165 my $s = PublicInbox::SearchIdx->new($ibx, 1);
166 $s->index_sync($opt);