]> Sergey Matveev's repositories - public-inbox.git/blob - lib/PublicInbox/Admin.pm
3977d8125fda558cd060a258be780d8ca0bd5afc
[public-inbox.git] / lib / PublicInbox / Admin.pm
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>
3
4 # common stuff for administrative command-line tools
5 # Unstable internal API
6 package PublicInbox::Admin;
7 use strict;
8 use parent qw(Exporter);
9 use Cwd qw(abs_path);
10 use POSIX ();
11 our @EXPORT_OK = qw(setup_signals);
12 use PublicInbox::Config;
13 use PublicInbox::Inbox;
14 use PublicInbox::Spawn qw(popen_rd);
15
16 sub setup_signals {
17         my ($cb, $arg) = @_; # optional
18
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 {
22                 my ($sig) = @_;
23                 # https://www.tldp.org/LDP/abs/html/exitcodes.html
24                 eval { $cb->($sig, $arg) } if $cb;
25                 $sig = 'SIG'.$sig;
26                 exit(128 + POSIX->$sig);
27         };
28 }
29
30 sub resolve_inboxdir {
31         my ($cd, $ver) = @_;
32         my $prefix = defined $cd ? $cd : './';
33         if (-d $prefix && -f "$prefix/inbox.lock") { # v2
34                 $$ver = 2 if $ver;
35                 return abs_path($prefix);
36         }
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";
41         chomp $dir;
42         $$ver = 1 if $ver;
43         return abs_path($cd) if ($dir eq '.' && defined $cd);
44         abs_path($dir);
45 }
46
47 # for unconfigured inboxes
48 sub detect_indexlevel ($) {
49         my ($ibx) = @_;
50
51         my $over = $ibx->over;
52         my $srch = $ibx->search;
53         delete @$ibx{qw(over search)}; # don't leave open FDs lying around
54
55         # brand new or never before indexed inboxes default to full
56         return 'full' unless $over;
57         my $l = 'basic';
58         return $l unless $srch;
59         if (my $xdb = $srch->xdb) {
60                 $l = 'full';
61                 my $m = $xdb->get_metadata('indexlevel');
62                 if ($m eq 'medium') {
63                         $l = $m;
64                 } elsif ($m ne '') {
65                         warn <<"";
66 $ibx->{inboxdir} has unexpected indexlevel in Xapian: $m
67
68                 }
69                 $ibx->{-skip_docdata} = 1 if $xdb->get_metadata('skip_docdata');
70         }
71         $l;
72 }
73
74 sub unconfigured_ibx ($$) {
75         my ($dir, $i) = @_;
76         my $name = "unconfigured-$i";
77         PublicInbox::Inbox->new({
78                 name => $name,
79                 address => [ "$name\@example.com" ],
80                 inboxdir => $dir,
81                 # TODO: consumers may want to warn on this:
82                 #-unconfigured => 1,
83         });
84 }
85
86 sub resolve_inboxes ($;$$) {
87         my ($argv, $opt, $cfg) = @_;
88         $opt ||= {};
89
90         $cfg //= PublicInbox::Config->new;
91         if ($opt->{all}) {
92                 my $cfgfile = PublicInbox::Config::default_file();
93                 $cfg or die "--all specified, but $cfgfile not readable\n";
94                 @$argv and die "--all specified, but directories specified\n";
95         }
96
97         my $min_ver = $opt->{-min_inbox_version} || 0;
98         my (@old, @ibxs);
99         my %dir2ibx;
100         my $all = $opt->{all} ? [] : undef;
101         if ($cfg) {
102                 $cfg->each_inbox(sub {
103                         my ($ibx) = @_;
104                         my $path = abs_path($ibx->{inboxdir});
105                         if (defined($path)) {
106                                 $dir2ibx{$path} = $ibx;
107                                 push @$all, $ibx if $all;
108                         } else {
109                                 warn <<EOF;
110 W: $ibx->{name} $ibx->{inboxdir}: $!
111 EOF
112                         }
113                 });
114         }
115         if ($all) {
116                 @$all = grep { $_->version >= $min_ver } @$all;
117                 @ibxs = @$all;
118         } else { # directories specified on the command-line
119                 my $i = 0;
120                 my @dirs = @$argv;
121                 push @dirs, '.' if !@dirs && $opt->{-use_cwd};
122                 foreach (@dirs) {
123                         my $v;
124                         my $dir = resolve_inboxdir($_, \$v);
125                         if ($v < $min_ver) {
126                                 push @old, $dir;
127                                 next;
128                         }
129                         my $ibx = $dir2ibx{$dir} ||= unconfigured_ibx($dir, $i);
130                         $i++;
131                         push @ibxs, $ibx;
132                 }
133         }
134         if (@old) {
135                 die "-V$min_ver inboxes not supported by $0\n\t",
136                     join("\n\t", @old), "\n";
137         }
138         @ibxs;
139 }
140
141 # TODO: make Devel::Peek optional, only used for daemon
142 my @base_mod = qw(Devel::Peek);
143 my @over_mod = qw(DBD::SQLite DBI);
144 my %mod_groups = (
145         -index => [ @base_mod, @over_mod ],
146         -base => \@base_mod,
147         -search => [ @base_mod, @over_mod, 'Search::Xapian' ],
148 );
149
150 sub scan_ibx_modules ($$) {
151         my ($mods, $ibx) = @_;
152         if (!$ibx->{indexlevel} || $ibx->{indexlevel} ne 'basic') {
153                 $mods->{'Search::Xapian'} = 1;
154         } else {
155                 $mods->{$_} = 1 foreach @over_mod;
156         }
157 }
158
159 sub check_require {
160         my (@mods) = @_;
161         my $err = {};
162         while (my $mod = shift @mods) {
163                 if (my $groups = $mod_groups{$mod}) {
164                         push @mods, @$groups;
165                 } elsif ($mod eq 'Search::Xapian') {
166                         require PublicInbox::Search;
167                         PublicInbox::Search::load_xapian() or
168                                 $err->{'Search::Xapian || Xapian'} = $@;
169                 } else {
170                         eval "require $mod";
171                         $err->{$mod} = $@ if $@;
172                 }
173         }
174         scalar keys %$err ? $err : undef;
175 }
176
177 sub missing_mod_msg {
178         my ($err) = @_;
179         my @mods = map { "`$_'" } sort keys %$err;
180         my $last = pop @mods;
181         @mods ? (join(', ', @mods)."' and $last") : $last
182 }
183
184 sub require_or_die {
185         my $err = check_require(@_) or return;
186         die missing_mod_msg($err)." required for $0\n";
187 }
188
189 sub indexlevel_ok_or_die ($) {
190         my ($indexlevel) = @_;
191         my $req;
192         if ($indexlevel eq 'basic') {
193                 $req = '-index';
194         } elsif ($indexlevel =~ /\A(?:medium|full)\z/) {
195                 $req = '-search';
196         } else {
197                 die <<"";
198 invalid indexlevel=$indexlevel (must be `basic', `medium', or `full')
199
200         }
201         my $err = check_require($req) or return;
202         die missing_mod_msg($err) ." required for indexlevel=$indexlevel\n";
203 }
204
205 sub index_terminate {
206         my (undef, $ibx) = @_; # $_[0] = signal name
207         $ibx->git->cleanup;
208 }
209
210 sub index_inbox {
211         my ($ibx, $im, $opt) = @_;
212         require PublicInbox::InboxWritable;
213         my $jobs = delete $opt->{jobs} if $opt;
214         if (my $pr = $opt->{-progress}) {
215                 $pr->("indexing $ibx->{inboxdir} ...\n");
216         }
217         local %SIG = %SIG;
218         setup_signals(\&index_terminate, $ibx);
219         my $warn_cb = $SIG{__WARN__} // sub { print STDERR @_ };
220         my $idx = { current_info => $ibx->{inboxdir} };
221         my $warn_ignore = PublicInbox::InboxWritable->can('warn_ignore');
222         local $SIG{__WARN__} = sub {
223                 return if $warn_ignore->(@_);
224                 $warn_cb->($idx->{current_info}, ': ', @_);
225         };
226         if (ref($ibx) && $ibx->version == 2) {
227                 eval { require PublicInbox::V2Writable };
228                 die "v2 requirements not met: $@\n" if $@;
229                 $ibx->{-creat_opt}->{nproc} = $jobs;
230                 my $v2w = $im // $ibx->importer($opt->{reindex} // $jobs);
231                 if (defined $jobs) {
232                         if ($jobs == 0) {
233                                 $v2w->{parallel} = 0;
234                         } else {
235                                 my $n = $v2w->{shards};
236                                 if ($jobs < ($n + 1) && !$opt->{reshard}) {
237                                         warn <<EOM;
238 Unable to respect --jobs=$jobs on index, inbox was created with $n shards
239 EOM
240                                 }
241                         }
242                 }
243                 $idx = $v2w;
244         } else {
245                 require PublicInbox::SearchIdx;
246                 $idx = PublicInbox::SearchIdx->new($ibx, 1);
247         }
248         $idx->index_sync($opt);
249 }
250
251 sub progress_prepare ($) {
252         my ($opt) = @_;
253
254         # public-inbox-index defaults to quiet, -xcpdb and -compact do not
255         if (defined($opt->{quiet}) && $opt->{quiet} < 0) {
256                 $opt->{quiet} = !$opt->{verbose};
257         }
258         if ($opt->{quiet}) {
259                 open my $null, '>', '/dev/null' or
260                         die "failed to open /dev/null: $!\n";
261                 $opt->{1} = $null; # suitable for spawn() redirect
262         } else {
263                 $opt->{verbose} ||= 1;
264                 $opt->{-progress} = sub { print STDERR @_ };
265         }
266 }
267
268 # same unit factors as git:
269 sub parse_unsigned ($) {
270         my ($val) = @_;
271
272         $$val =~ /\A([0-9]+)([kmg])?\z/i or return;
273         my ($n, $unit_factor) = ($1, $2 // '');
274         my %u = ( k => 1024, m => 1024**2, g => 1024**3 );
275         $$val = $n * ($u{lc($unit_factor)} // 1);
276         1;
277 }
278
279 sub index_prepare ($$) {
280         my ($opt, $cfg) = @_;
281         my $env;
282         if ($opt->{compact}) {
283                 require PublicInbox::Xapcmd;
284                 PublicInbox::Xapcmd::check_compact();
285                 $opt->{compact_opt} = { -coarse_lock => 1, compact => 1 };
286                 if (defined(my $jobs = $opt->{jobs})) {
287                         $opt->{compact_opt}->{jobs} = $jobs;
288                 }
289         }
290         for my $k (qw(max_size batch_size)) {
291                 my $git_key = "publicInbox.index".ucfirst($k);
292                 $git_key =~ s/_([a-z])/\U$1/g;
293                 defined(my $v = $opt->{$k} // $cfg->{lc($git_key)}) or next;
294                 parse_unsigned(\$v) or die "`$git_key=$v' not parsed\n";
295                 $v > 0 or die "`$git_key=$v' must be positive\n";
296                 $opt->{$k} = $v;
297         }
298
299         # out-of-the-box builds of Xapian 1.4.x are still limited to 32-bit
300         # https://getting-started-with-xapian.readthedocs.io/en/latest/concepts/indexing/limitations.html
301         $opt->{batch_size} and
302                 $env = { XAPIAN_FLUSH_THRESHOLD => '4294967295' };
303
304         for my $k (qw(sequential_shard)) {
305                 my $git_key = "publicInbox.index".ucfirst($k);
306                 $git_key =~ s/_([a-z])/\U$1/g;
307                 defined(my $s = $opt->{$k} // $cfg->{lc($git_key)}) or next;
308                 defined(my $v = $cfg->git_bool($s))
309                                         or die "`$git_key=$s' not boolean\n";
310                 $opt->{$k} = $v;
311         }
312         $env;
313 }
314
315 1;