]> Sergey Matveev's repositories - public-inbox.git/blob - lib/PublicInbox/V2Writable.pm
v2: SDBM-based multi Message-ID queue
[public-inbox.git] / lib / PublicInbox / V2Writable.pm
1 # Copyright (C) 2018-2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
3
4 # This interface wraps and mimics PublicInbox::Import
5 # Used to write to V2 inboxes (see L<public-inbox-v2-format(5)>).
6 package PublicInbox::V2Writable;
7 use strict;
8 use warnings;
9 use base qw(PublicInbox::Lock);
10 use 5.010_001;
11 use PublicInbox::SearchIdxShard;
12 use PublicInbox::MIME;
13 use PublicInbox::Git;
14 use PublicInbox::Import;
15 use PublicInbox::MID qw(mids references);
16 use PublicInbox::ContentId qw(content_id content_digest);
17 use PublicInbox::Inbox;
18 use PublicInbox::OverIdx;
19 use PublicInbox::Msgmap;
20 use PublicInbox::Spawn qw(spawn popen_rd);
21 use PublicInbox::SearchIdx;
22 use PublicInbox::MsgTime qw(msg_timestamp msg_datestamp);
23 use PublicInbox::MultiMidQueue;
24 use IO::Handle; # ->autoflush
25 use File::Temp qw(tempfile);
26
27 # an estimate of the post-packed size to the raw uncompressed size
28 my $PACKING_FACTOR = 0.4;
29
30 # SATA storage lags behind what CPUs are capable of, so relying on
31 # nproc(1) can be misleading and having extra Xapian shards is a
32 # waste of FDs and space.  It can also lead to excessive IO latency
33 # and slow things down.  Users on NVME or other fast storage can
34 # use the NPROC env or switches in our script/public-inbox-* programs
35 # to increase Xapian shards
36 our $NPROC_MAX_DEFAULT = 4;
37
38 sub detect_nproc () {
39         for my $nproc (qw(nproc gnproc)) { # GNU coreutils nproc
40                 `$nproc 2>/dev/null` =~ /^(\d+)$/ and return $1;
41         }
42
43         # getconf(1) is POSIX, but *NPROCESSORS* vars are not
44         for (qw(_NPROCESSORS_ONLN NPROCESSORS_ONLN)) {
45                 `getconf $_ 2>/dev/null` =~ /^(\d+)$/ and return $1;
46         }
47
48         # should we bother with `sysctl hw.ncpu`?  Those only give
49         # us total processor count, not online processor count.
50         undef
51 }
52
53 sub nproc_shards ($) {
54         my ($creat_opt) = @_;
55         my $n = $creat_opt->{nproc} if ref($creat_opt) eq 'HASH';
56         $n //= $ENV{NPROC};
57         if (!$n) {
58                 # assume 2 cores if not detectable or zero
59                 state $NPROC_DETECTED = detect_nproc() || 2;
60                 $n = $NPROC_DETECTED;
61                 $n = $NPROC_MAX_DEFAULT if $n > $NPROC_MAX_DEFAULT;
62         }
63
64         # subtract for the main process and git-fast-import
65         $n -= 1;
66         $n < 1 ? 1 : $n;
67 }
68
69 sub count_shards ($) {
70         my ($self) = @_;
71         my $n = 0;
72         my $xpfx = $self->{xpfx};
73
74         # always load existing shards in case core count changes:
75         # Also, shard count may change while -watch is running
76         # due to "xcpdb --reshard"
77         if (-d $xpfx) {
78                 require PublicInbox::Search;
79                 PublicInbox::Search::load_xapian();
80                 my $XapianDatabase = $PublicInbox::Search::X{Database};
81                 foreach my $shard (<$xpfx/*>) {
82                         -d $shard && $shard =~ m!/[0-9]+\z! or next;
83                         eval {
84                                 $XapianDatabase->new($shard)->close;
85                                 $n++;
86                         };
87                 }
88         }
89         $n;
90 }
91
92 sub new {
93         # $creat may be any true value, or 0/undef.  A hashref is true,
94         # and $creat->{nproc} may be set to an integer
95         my ($class, $v2ibx, $creat) = @_;
96         $v2ibx = PublicInbox::InboxWritable->new($v2ibx);
97         my $dir = $v2ibx->assert_usable_dir;
98         unless (-d $dir) {
99                 if ($creat) {
100                         require File::Path;
101                         File::Path::mkpath($dir);
102                 } else {
103                         die "$dir does not exist\n";
104                 }
105         }
106         $v2ibx->umask_prepare;
107
108         my $xpfx = "$dir/xap" . PublicInbox::Search::SCHEMA_VERSION;
109         my $self = {
110                 -inbox => $v2ibx,
111                 im => undef, #  PublicInbox::Import
112                 parallel => 1,
113                 transact_bytes => 0,
114                 current_info => '',
115                 xpfx => $xpfx,
116                 over => PublicInbox::OverIdx->new("$xpfx/over.sqlite3", 1),
117                 lock_path => "$dir/inbox.lock",
118                 # limit each git repo (epoch) to 1GB or so
119                 rotate_bytes => int((1024 * 1024 * 1024) / $PACKING_FACTOR),
120                 last_commit => [], # git repo -> commit
121         };
122         $self->{shards} = count_shards($self) || nproc_shards($creat);
123         bless $self, $class;
124 }
125
126 # public (for now?)
127 sub init_inbox {
128         my ($self, $shards, $skip_epoch) = @_;
129         if (defined $shards) {
130                 $self->{parallel} = 0 if $shards == 0;
131                 $self->{shards} = $shards if $shards > 0;
132         }
133         $self->idx_init;
134         my $epoch_max = -1;
135         git_dir_latest($self, \$epoch_max);
136         if (defined $skip_epoch && $epoch_max == -1) {
137                 $epoch_max = $skip_epoch;
138         }
139         $self->git_init($epoch_max >= 0 ? $epoch_max : 0);
140         $self->done;
141 }
142
143 # returns undef on duplicate or spam
144 # mimics Import::add and wraps it for v2
145 sub add {
146         my ($self, $mime, $check_cb) = @_;
147         $self->{-inbox}->with_umask(sub {
148                 _add($self, $mime, $check_cb)
149         });
150 }
151
152 # indexes a message, returns true if checkpointing is needed
153 sub do_idx ($$$$) {
154         my ($self, $msgref, $mime, $smsg) = @_;
155         $smsg->{ds} //= msg_datestamp($mime->header_obj, $self->{autime});
156         $smsg->{ts} //= msg_timestamp($mime->header_obj, $self->{cotime});
157         $self->{over}->add_overview($mime, $smsg);
158         my $idx = idx_shard($self, $smsg->{num} % $self->{shards});
159         $idx->index_raw($msgref, $mime, $smsg);
160         my $n = $self->{transact_bytes} += $smsg->{bytes};
161         $n >= (PublicInbox::SearchIdx::BATCH_BYTES * $self->{shards});
162 }
163
164 sub _add {
165         my ($self, $mime, $check_cb) = @_;
166
167         # spam check:
168         if ($check_cb) {
169                 $mime = $check_cb->($mime) or return;
170         }
171
172         # All pipes (> $^F) known to Perl 5.6+ have FD_CLOEXEC set,
173         # as does SQLite 3.4.1+ (released in 2007-07-20), and
174         # Xapian 1.3.2+ (released 2015-03-15).
175         # For the most part, we can spawn git-fast-import without
176         # leaking FDs to it...
177         $self->idx_init;
178
179         my ($num, $mid0) = v2_num_for($self, $mime);
180         defined $num or return; # duplicate
181         defined $mid0 or die "BUG: $mid0 undefined\n";
182         my $im = $self->importer;
183         my $smsg = bless { mid => $mid0, num => $num }, 'PublicInbox::Smsg';
184         my $cmt = $im->add($mime, undef, $smsg); # sets $smsg->{ds|ts|blob}
185         $cmt = $im->get_mark($cmt);
186         $self->{last_commit}->[$self->{epoch_max}] = $cmt;
187
188         my $msgref = delete $smsg->{-raw_email};
189         if (do_idx($self, $msgref, $mime, $smsg)) {
190                 $self->checkpoint;
191         }
192
193         $cmt;
194 }
195
196 sub v2_num_for {
197         my ($self, $mime) = @_;
198         my $mids = mids($mime->header_obj);
199         if (@$mids) {
200                 my $mid = $mids->[0];
201                 my $num = $self->{mm}->mid_insert($mid);
202                 if (defined $num) { # common case
203                         return ($num, $mid);
204                 }
205
206                 # crap, Message-ID is already known, hope somebody just resent:
207                 foreach my $m (@$mids) {
208                         # read-only lookup now safe to do after above barrier
209                         # easy, don't store duplicates
210                         # note: do not add more diagnostic info here since
211                         # it gets noisy on public-inbox-watch restarts
212                         return () if content_exists($self, $mime, $m);
213                 }
214
215                 # AltId may pre-populate article numbers (e.g. X-Mail-Count
216                 # or NNTP article number), use that article number if it's
217                 # not in Over.
218                 my $altid = $self->{-inbox}->{altid};
219                 if ($altid && grep(/:file=msgmap\.sqlite3\z/, @$altid)) {
220                         my $num = $self->{mm}->num_for($mid);
221
222                         if (defined $num && !$self->{over}->get_art($num)) {
223                                 return ($num, $mid);
224                         }
225                 }
226
227                 # very unlikely:
228                 warn "<$mid> reused for mismatched content\n";
229
230                 # try the rest of the mids
231                 for(my $i = $#$mids; $i >= 1; $i--) {
232                         my $m = $mids->[$i];
233                         $num = $self->{mm}->mid_insert($m);
234                         if (defined $num) {
235                                 warn "alternative <$m> for <$mid> found\n";
236                                 return ($num, $m);
237                         }
238                 }
239         }
240         # none of the existing Message-IDs are good, generate a new one:
241         v2_num_for_harder($self, $mime);
242 }
243
244 sub v2_num_for_harder {
245         my ($self, $mime) = @_;
246
247         my $hdr = $mime->header_obj;
248         my $dig = content_digest($mime);
249         my $mid0 = PublicInbox::Import::digest2mid($dig, $hdr);
250         my $num = $self->{mm}->mid_insert($mid0);
251         unless (defined $num) {
252                 # it's hard to spoof the last Received: header
253                 my @recvd = $hdr->header_raw('Received');
254                 $dig->add("Received: $_") foreach (@recvd);
255                 $mid0 = PublicInbox::Import::digest2mid($dig, $hdr);
256                 $num = $self->{mm}->mid_insert($mid0);
257
258                 # fall back to a random Message-ID and give up determinism:
259                 until (defined($num)) {
260                         $dig->add(rand);
261                         $mid0 = PublicInbox::Import::digest2mid($dig, $hdr);
262                         warn "using random Message-ID <$mid0> as fallback\n";
263                         $num = $self->{mm}->mid_insert($mid0);
264                 }
265         }
266         PublicInbox::Import::append_mid($hdr, $mid0);
267         ($num, $mid0);
268 }
269
270 sub idx_shard {
271         my ($self, $shard_i) = @_;
272         $self->{idx_shards}->[$shard_i];
273 }
274
275 # idempotent
276 sub idx_init {
277         my ($self, $opt) = @_;
278         return if $self->{idx_shards};
279         my $ibx = $self->{-inbox};
280
281         # do not leak read-only FDs to child processes, we only have these
282         # FDs for duplicate detection so they should not be
283         # frequently activated.
284         delete $ibx->{$_} foreach (qw(git mm search));
285
286         my $indexlevel = $ibx->{indexlevel};
287         if ($indexlevel && $indexlevel eq 'basic') {
288                 $self->{parallel} = 0;
289         }
290
291         if ($self->{parallel}) {
292                 pipe(my ($r, $w)) or die "pipe failed: $!";
293                 # pipe for barrier notifications doesn't need to be big,
294                 # 1031: F_SETPIPE_SZ
295                 fcntl($w, 1031, 4096) if $^O eq 'linux';
296                 $self->{bnote} = [ $r, $w ];
297                 $w->autoflush(1);
298         }
299
300         my $over = $self->{over};
301         $ibx->umask_prepare;
302         $ibx->with_umask(sub {
303                 $self->lock_acquire unless ($opt && $opt->{-skip_lock});
304                 $over->create;
305
306                 # xcpdb can change shard count while -watch is idle
307                 my $nshards = count_shards($self);
308                 if ($nshards && $nshards != $self->{shards}) {
309                         $self->{shards} = $nshards;
310                 }
311
312                 # need to create all shards before initializing msgmap FD
313                 my $max = $self->{shards} - 1;
314
315                 # idx_shards must be visible to all forked processes
316                 my $idx = $self->{idx_shards} = [];
317                 for my $i (0..$max) {
318                         push @$idx, PublicInbox::SearchIdxShard->new($self, $i);
319                 }
320
321                 # Now that all subprocesses are up, we can open the FDs
322                 # for SQLite:
323                 my $mm = $self->{mm} = PublicInbox::Msgmap->new_file(
324                         "$self->{-inbox}->{inboxdir}/msgmap.sqlite3", 1);
325                 $mm->{dbh}->begin_work;
326         });
327 }
328
329 # returns an array mapping [ epoch => latest_commit ]
330 # latest_commit may be undef if nothing was done to that epoch
331 # $replace_map = { $object_id => $strref, ... }
332 sub _replace_oids ($$$) {
333         my ($self, $mime, $replace_map) = @_;
334         $self->done;
335         my $pfx = "$self->{-inbox}->{inboxdir}/git";
336         my $rewrites = []; # epoch => commit
337         my $max = $self->{epoch_max};
338
339         unless (defined($max)) {
340                 defined(my $latest = git_dir_latest($self, \$max)) or return;
341                 $self->{epoch_max} = $max;
342         }
343
344         foreach my $i (0..$max) {
345                 my $git_dir = "$pfx/$i.git";
346                 -d $git_dir or next;
347                 my $git = PublicInbox::Git->new($git_dir);
348                 my $im = $self->import_init($git, 0, 1);
349                 $rewrites->[$i] = $im->replace_oids($mime, $replace_map);
350                 $im->done;
351         }
352         $rewrites;
353 }
354
355 sub content_ids ($) {
356         my ($mime) = @_;
357         my @cids = ( content_id($mime) );
358
359         # Email::MIME->as_string doesn't always round-trip, so we may
360         # use a second content_id
361         my $rt = content_id(PublicInbox::MIME->new(\($mime->as_string)));
362         push @cids, $rt if $cids[0] ne $rt;
363         \@cids;
364 }
365
366 sub content_matches ($$) {
367         my ($cids, $existing) = @_;
368         my $cid = content_id($existing);
369         foreach (@$cids) {
370                 return 1 if $_ eq $cid
371         }
372         0
373 }
374
375 # used for removing or replacing (purging)
376 sub rewrite_internal ($$;$$$) {
377         my ($self, $old_mime, $cmt_msg, $new_mime, $sref) = @_;
378         $self->idx_init;
379         my ($im, $need_reindex, $replace_map);
380         if ($sref) {
381                 $replace_map = {}; # oid => sref
382                 $need_reindex = [] if $new_mime;
383         } else {
384                 $im = $self->importer;
385         }
386         my $over = $self->{over};
387         my $cids = content_ids($old_mime);
388         my @removed;
389         my $mids = mids($old_mime->header_obj);
390
391         # We avoid introducing new blobs into git since the raw content
392         # can be slightly different, so we do not need the user-supplied
393         # message now that we have the mids and content_id
394         $old_mime = undef;
395         my $mark;
396
397         foreach my $mid (@$mids) {
398                 my %gone; # num => [ smsg, $mime, raw ]
399                 my ($id, $prev);
400                 while (my $smsg = $over->next_by_mid($mid, \$id, \$prev)) {
401                         my $msg = get_blob($self, $smsg);
402                         if (!defined($msg)) {
403                                 warn "broken smsg for $mid\n";
404                                 next; # continue
405                         }
406                         my $orig = $$msg;
407                         my $cur = PublicInbox::MIME->new($msg);
408                         if (content_matches($cids, $cur)) {
409                                 $gone{$smsg->{num}} = [ $smsg, $cur, \$orig ];
410                         }
411                 }
412                 my $n = scalar keys %gone;
413                 next unless $n;
414                 if ($n > 1) {
415                         warn "BUG: multiple articles linked to <$mid>\n",
416                                 join(',', sort keys %gone), "\n";
417                 }
418                 foreach my $num (keys %gone) {
419                         my ($smsg, $mime, $orig) = @{$gone{$num}};
420                         # @removed should only be set once assuming
421                         # no bugs in our deduplication code:
422                         @removed = (undef, $mime, $smsg);
423                         my $oid = $smsg->{blob};
424                         if ($replace_map) {
425                                 $replace_map->{$oid} = $sref;
426                         } else {
427                                 ($mark, undef) = $im->remove($orig, $cmt_msg);
428                                 $removed[0] = $mark;
429                         }
430                         $orig = undef;
431                         if ($need_reindex) { # ->replace
432                                 push @$need_reindex, $smsg;
433                         } else { # ->purge or ->remove
434                                 $self->{mm}->num_delete($num);
435                         }
436                         unindex_oid_remote($self, $oid, $mid);
437                 }
438         }
439
440         if (defined $mark) {
441                 my $cmt = $im->get_mark($mark);
442                 $self->{last_commit}->[$self->{epoch_max}] = $cmt;
443         }
444         if ($replace_map && scalar keys %$replace_map) {
445                 my $rewrites = _replace_oids($self, $new_mime, $replace_map);
446                 return { rewrites => $rewrites, need_reindex => $need_reindex };
447         }
448         defined($mark) ? @removed : undef;
449 }
450
451 # public (see PublicInbox::Import->remove), but note the 3rd element
452 # (retval[2]) is not part of the stable API shared with Import->remove
453 sub remove {
454         my ($self, $mime, $cmt_msg) = @_;
455         my @ret;
456         $self->{-inbox}->with_umask(sub {
457                 @ret = rewrite_internal($self, $mime, $cmt_msg);
458         });
459         defined($ret[0]) ? @ret : undef;
460 }
461
462 sub _replace ($$;$$) {
463         my ($self, $old_mime, $new_mime, $sref) = @_;
464         my $rewritten = $self->{-inbox}->with_umask(sub {
465                 rewrite_internal($self, $old_mime, undef, $new_mime, $sref);
466         }) or return;
467
468         my $rewrites = $rewritten->{rewrites};
469         # ->done is called if there are rewrites since we gc+prune from git
470         $self->idx_init if @$rewrites;
471
472         for my $i (0..$#$rewrites) {
473                 defined(my $cmt = $rewrites->[$i]) or next;
474                 $self->{last_commit}->[$i] = $cmt;
475         }
476         $rewritten;
477 }
478
479 # public
480 sub purge {
481         my ($self, $mime) = @_;
482         my $rewritten = _replace($self, $mime, undef, \'') or return;
483         $rewritten->{rewrites}
484 }
485
486 # returns the git object_id of $fh, does not write the object to FS
487 sub git_hash_raw ($$) {
488         my ($self, $raw) = @_;
489         # grab the expected OID we have to reindex:
490         open my $tmp_fh, '+>', undef or die "failed to open tmp: $!";
491         $tmp_fh->autoflush(1);
492         print $tmp_fh $$raw or die "print \$tmp_fh: $!";
493         sysseek($tmp_fh, 0, 0) or die "seek failed: $!";
494
495         my $git_dir = $self->{-inbox}->git->{git_dir};
496         my $cmd = ['git', "--git-dir=$git_dir", qw(hash-object --stdin)];
497         my $r = popen_rd($cmd, undef, { 0 => $tmp_fh });
498         local $/ = "\n";
499         chomp(my $oid = <$r>);
500         close $r or die "git hash-object failed: $?";
501         $oid =~ /\A[a-f0-9]{40}\z/ or die "OID not expected: $oid";
502         $oid;
503 }
504
505 sub _check_mids_match ($$$) {
506         my ($old_list, $new_list, $hdrs) = @_;
507         my %old_mids = map { $_ => 1 } @$old_list;
508         my %new_mids = map { $_ => 1 } @$new_list;
509         my @old = keys %old_mids;
510         my @new = keys %new_mids;
511         my $err = "$hdrs may not be changed when replacing\n";
512         die $err if scalar(@old) != scalar(@new);
513         delete @new_mids{@old};
514         delete @old_mids{@new};
515         die $err if (scalar(keys %old_mids) || scalar(keys %new_mids));
516 }
517
518 # Changing Message-IDs or References with ->replace isn't supported.
519 # The rules for dealing with messages with multiple or conflicting
520 # Message-IDs are pretty complex and rethreading hasn't been fully
521 # implemented, yet.
522 sub check_mids_match ($$) {
523         my ($old_mime, $new_mime) = @_;
524         my $old = $old_mime->header_obj;
525         my $new = $new_mime->header_obj;
526         _check_mids_match(mids($old), mids($new), 'Message-ID(s)');
527         _check_mids_match(references($old), references($new),
528                         'References/In-Reply-To');
529 }
530
531 # public
532 sub replace ($$$) {
533         my ($self, $old_mime, $new_mime) = @_;
534
535         check_mids_match($old_mime, $new_mime);
536
537         # mutt will always add Content-Length:, Status:, Lines: when editing
538         PublicInbox::Import::drop_unwanted_headers($new_mime);
539
540         my $raw = $new_mime->as_string;
541         my $expect_oid = git_hash_raw($self, \$raw);
542         my $rewritten = _replace($self, $old_mime, $new_mime, \$raw) or return;
543         my $need_reindex = $rewritten->{need_reindex};
544
545         # just in case we have bugs in deduplication code:
546         my $n = scalar(@$need_reindex);
547         if ($n > 1) {
548                 my $list = join(', ', map {
549                                         "$_->{num}: <$_->{mid}>"
550                                 } @$need_reindex);
551                 warn <<"";
552 W: rewritten $n messages matching content of original message (expected: 1).
553 W: possible bug in public-inbox, NNTP article IDs and Message-IDs follow:
554 W: $list
555
556         }
557
558         # make sure we really got the OID:
559         my ($blob, $type, $bytes) = $self->{-inbox}->git->check($expect_oid);
560         $blob eq $expect_oid or die "BUG: $expect_oid not found after replace";
561
562         # don't leak FDs to Xapian:
563         $self->{-inbox}->git->cleanup;
564
565         # reindex modified messages:
566         for my $smsg (@$need_reindex) {
567                 my $new_smsg = bless {
568                         blob => $blob,
569                         bytes => $bytes,
570                         num => $smsg->{num},
571                         mid => $smsg->{mid},
572                 }, 'PublicInbox::Smsg';
573                 do_idx($self, \$raw, $new_mime, $new_smsg);
574         }
575         $rewritten->{rewrites};
576 }
577
578 sub last_epoch_commit ($$;$) {
579         my ($self, $i, $cmt) = @_;
580         my $v = PublicInbox::Search::SCHEMA_VERSION();
581         $self->{mm}->last_commit_xap($v, $i, $cmt);
582 }
583
584 sub set_last_commits ($) {
585         my ($self) = @_;
586         defined(my $epoch_max = $self->{epoch_max}) or return;
587         my $last_commit = $self->{last_commit};
588         foreach my $i (0..$epoch_max) {
589                 defined(my $cmt = $last_commit->[$i]) or next;
590                 $last_commit->[$i] = undef;
591                 last_epoch_commit($self, $i, $cmt);
592         }
593 }
594
595 sub barrier_init {
596         my ($self, $n) = @_;
597         $self->{bnote} or return;
598         --$n;
599         my $barrier = { map { $_ => 1 } (0..$n) };
600 }
601
602 sub barrier_wait {
603         my ($self, $barrier) = @_;
604         my $bnote = $self->{bnote} or return;
605         my $r = $bnote->[0];
606         while (scalar keys %$barrier) {
607                 defined(my $l = $r->getline) or die "EOF on barrier_wait: $!";
608                 $l =~ /\Abarrier (\d+)/ or die "bad line on barrier_wait: $l";
609                 delete $barrier->{$1} or die "bad shard[$1] on barrier wait";
610         }
611 }
612
613 # public
614 sub checkpoint ($;$) {
615         my ($self, $wait) = @_;
616
617         if (my $im = $self->{im}) {
618                 if ($wait) {
619                         $im->barrier;
620                 } else {
621                         $im->checkpoint;
622                 }
623         }
624         my $shards = $self->{idx_shards};
625         if ($shards) {
626                 my $dbh = $self->{mm}->{dbh};
627
628                 # SQLite msgmap data is second in importance
629                 $dbh->commit;
630
631                 # SQLite overview is third
632                 $self->{over}->commit_lazy;
633
634                 # Now deal with Xapian
635                 if ($wait) {
636                         my $barrier = $self->barrier_init(scalar @$shards);
637
638                         # each shard needs to issue a barrier command
639                         $_->remote_barrier for @$shards;
640
641                         # wait for each Xapian shard
642                         $self->barrier_wait($barrier);
643                 } else {
644                         $_->remote_commit for @$shards;
645                 }
646
647                 # last_commit is special, don't commit these until
648                 # remote shards are done:
649                 $dbh->begin_work;
650                 set_last_commits($self);
651                 $dbh->commit;
652
653                 $dbh->begin_work;
654         }
655         $self->{transact_bytes} = 0;
656 }
657
658 # issue a write barrier to ensure all data is visible to other processes
659 # and read-only ops.  Order of data importance is: git > SQLite > Xapian
660 # public
661 sub barrier { checkpoint($_[0], 1) };
662
663 # public
664 sub done {
665         my ($self) = @_;
666         my $im = delete $self->{im};
667         $im->done if $im; # PublicInbox::Import::done
668         checkpoint($self);
669         my $mm = delete $self->{mm};
670         $mm->{dbh}->commit if $mm;
671         my $shards = delete $self->{idx_shards};
672         if ($shards) {
673                 $_->remote_close for @$shards;
674         }
675         $self->{over}->disconnect;
676         delete $self->{bnote};
677         $self->{transact_bytes} = 0;
678         $self->lock_release if $shards;
679         $self->{-inbox}->git->cleanup;
680 }
681
682 sub fill_alternates ($$) {
683         my ($self, $epoch) = @_;
684
685         my $pfx = "$self->{-inbox}->{inboxdir}/git";
686         my $all = "$self->{-inbox}->{inboxdir}/all.git";
687
688         unless (-d $all) {
689                 PublicInbox::Import::init_bare($all);
690         }
691         my $info_dir = "$all/objects/info";
692         my $alt = "$info_dir/alternates";
693         my (%alt, $new);
694         my $mode = 0644;
695         if (-e $alt) {
696                 open(my $fh, '<', $alt) or die "open < $alt: $!\n";
697                 $mode = (stat($fh))[2] & 07777;
698
699                 # we assign a sort score to every alternate and favor
700                 # the newest (highest numbered) one when we
701                 my $score;
702                 my $other = 0; # in case admin adds non-epoch repos
703                 %alt = map {;
704                         if (m!\A\Q../../\E([0-9]+)\.git/objects\z!) {
705                                 $score = $1 + 0;
706                         } else {
707                                 $score = --$other;
708                         }
709                         $_ => $score;
710                 } split(/\n+/, do { local $/; <$fh> });
711         }
712
713         foreach my $i (0..$epoch) {
714                 my $dir = "../../git/$i.git/objects";
715                 if (!exists($alt{$dir}) && -d "$pfx/$i.git") {
716                         $alt{$dir} = $i;
717                         $new = 1;
718                 }
719         }
720         return unless $new;
721
722         my ($fh, $tmp) = tempfile('alt-XXXXXXXX', DIR => $info_dir);
723         print $fh join("\n", sort { $alt{$b} <=> $alt{$a} } keys %alt), "\n"
724                 or die "print $tmp: $!\n";
725         chmod($mode, $fh) or die "fchmod $tmp: $!\n";
726         close $fh or die "close $tmp $!\n";
727         rename($tmp, $alt) or die "rename $tmp => $alt: $!\n";
728 }
729
730 sub git_init {
731         my ($self, $epoch) = @_;
732         my $git_dir = "$self->{-inbox}->{inboxdir}/git/$epoch.git";
733         my @cmd = (qw(git init --bare -q), $git_dir);
734         PublicInbox::Import::run_die(\@cmd);
735         @cmd = (qw/git config/, "--file=$git_dir/config",
736                         'include.path', '../../all.git/config');
737         PublicInbox::Import::run_die(\@cmd);
738         fill_alternates($self, $epoch);
739         $git_dir
740 }
741
742 sub git_dir_latest {
743         my ($self, $max) = @_;
744         $$max = -1;
745         my $pfx = "$self->{-inbox}->{inboxdir}/git";
746         return unless -d $pfx;
747         my $latest;
748         opendir my $dh, $pfx or die "opendir $pfx: $!\n";
749         while (defined(my $git_dir = readdir($dh))) {
750                 $git_dir =~ m!\A([0-9]+)\.git\z! or next;
751                 if ($1 > $$max) {
752                         $$max = $1;
753                         $latest = "$pfx/$git_dir";
754                 }
755         }
756         $latest;
757 }
758
759 sub importer {
760         my ($self) = @_;
761         my $im = $self->{im};
762         if ($im) {
763                 if ($im->{bytes_added} < $self->{rotate_bytes}) {
764                         return $im;
765                 } else {
766                         $self->{im} = undef;
767                         $im->done;
768                         $im = undef;
769                         $self->checkpoint;
770                         my $git_dir = $self->git_init(++$self->{epoch_max});
771                         my $git = PublicInbox::Git->new($git_dir);
772                         return $self->import_init($git, 0);
773                 }
774         }
775         my $epoch = 0;
776         my $max;
777         my $latest = git_dir_latest($self, \$max);
778         if (defined $latest) {
779                 my $git = PublicInbox::Git->new($latest);
780                 my $packed_bytes = $git->packed_bytes;
781                 my $unpacked_bytes = $packed_bytes / $PACKING_FACTOR;
782
783                 if ($unpacked_bytes >= $self->{rotate_bytes}) {
784                         $epoch = $max + 1;
785                 } else {
786                         $self->{epoch_max} = $max;
787                         return $self->import_init($git, $packed_bytes);
788                 }
789         }
790         $self->{epoch_max} = $epoch;
791         $latest = $self->git_init($epoch);
792         $self->import_init(PublicInbox::Git->new($latest), 0);
793 }
794
795 sub import_init {
796         my ($self, $git, $packed_bytes, $tmp) = @_;
797         my $im = PublicInbox::Import->new($git, undef, undef, $self->{-inbox});
798         $im->{bytes_added} = int($packed_bytes / $PACKING_FACTOR);
799         $im->{lock_path} = undef;
800         $im->{path_type} = 'v2';
801         $self->{im} = $im unless $tmp;
802         $im;
803 }
804
805 # XXX experimental
806 sub diff ($$$) {
807         my ($mid, $cur, $new) = @_;
808
809         my ($ah, $an) = tempfile('email-cur-XXXXXXXX', TMPDIR => 1);
810         print $ah $cur->as_string or die "print: $!";
811         close $ah or die "close: $!";
812         my ($bh, $bn) = tempfile('email-new-XXXXXXXX', TMPDIR => 1);
813         PublicInbox::Import::drop_unwanted_headers($new);
814         print $bh $new->as_string or die "print: $!";
815         close $bh or die "close: $!";
816         my $cmd = [ qw(diff -u), $an, $bn ];
817         print STDERR "# MID conflict <$mid>\n";
818         my $pid = spawn($cmd, undef, { 1 => 2 });
819         waitpid($pid, 0) == $pid or die "diff did not finish";
820         unlink($an, $bn);
821 }
822
823 sub get_blob ($$) {
824         my ($self, $smsg) = @_;
825         if (my $im = $self->{im}) {
826                 my $msg = $im->cat_blob($smsg->{blob});
827                 return $msg if $msg;
828         }
829         # older message, should be in alternates
830         my $ibx = $self->{-inbox};
831         $ibx->msg_by_smsg($smsg);
832 }
833
834 sub content_exists ($$$) {
835         my ($self, $mime, $mid) = @_;
836         my $over = $self->{over};
837         my $cids = content_ids($mime);
838         my ($id, $prev);
839         while (my $smsg = $over->next_by_mid($mid, \$id, \$prev)) {
840                 my $msg = get_blob($self, $smsg);
841                 if (!defined($msg)) {
842                         warn "broken smsg for $mid\n";
843                         next;
844                 }
845                 my $cur = PublicInbox::MIME->new($msg);
846                 return 1 if content_matches($cids, $cur);
847
848                 # XXX DEBUG_DIFF is experimental and may be removed
849                 diff($mid, $cur, $mime) if $ENV{DEBUG_DIFF};
850         }
851         undef;
852 }
853
854 sub atfork_child {
855         my ($self) = @_;
856         my $fh = delete $self->{reindex_pipe};
857         close $fh if $fh;
858         if (my $shards = $self->{idx_shards}) {
859                 $_->atfork_child foreach @$shards;
860         }
861         if (my $im = $self->{im}) {
862                 $im->atfork_child;
863         }
864         die "unexpected mm" if $self->{mm};
865         close $self->{bnote}->[0] or die "close bnote[0]: $!\n";
866         $self->{bnote}->[1];
867 }
868
869 sub mark_deleted ($$$$) {
870         my ($self, $sync, $git, $oid) = @_;
871         my $msgref = $git->cat_file($oid);
872         my $mime = PublicInbox::MIME->new($$msgref);
873         my $mids = mids($mime->header_obj);
874         my $cid = content_id($mime);
875         foreach my $mid (@$mids) {
876                 $sync->{D}->{"$mid\0$cid"} = $oid;
877         }
878 }
879
880 sub reindex_checkpoint ($$$) {
881         my ($self, $sync, $git) = @_;
882
883         $git->cleanup;
884         $sync->{mm_tmp}->atfork_prepare;
885         $self->done; # release lock
886
887         if (my $pr = $sync->{-opt}->{-progress}) {
888                 my ($bn) = (split('/', $git->{git_dir}))[-1];
889                 $pr->("$bn ".sprintf($sync->{-regen_fmt}, $sync->{nr}));
890         }
891
892         # allow -watch or -mda to write...
893         $self->idx_init; # reacquire lock
894         $sync->{mm_tmp}->atfork_parent;
895 }
896
897 # only for a few odd messages with multiple Message-IDs
898 sub reindex_oid_m ($$$$;$) {
899         my ($self, $sync, $git, $oid, $regen_num) = @_;
900         $self->{current_info} = "multi_mid $oid";
901         my ($num, $mid0, $len);
902         my $msgref = $git->cat_file($oid, \$len);
903         my $mime = PublicInbox::MIME->new($$msgref);
904         my $mids = mids($mime->header_obj);
905         my $cid = content_id($mime);
906         die "BUG: reindex_oid_m called for <=1 mids" if scalar(@$mids) <= 1;
907
908         for my $mid (reverse @$mids) {
909                 delete($sync->{D}->{"$mid\0$cid"}) and
910                         die "BUG: reindex_oid should handle <$mid> delete";
911         }
912         my $over = $self->{over};
913         for my $mid (reverse @$mids) {
914                 ($num, $mid0) = $over->num_mid0_for_oid($oid, $mid);
915                 next unless defined $num;
916                 if (defined($regen_num) && $regen_num != $num) {
917                         die "BUG: regen(#$regen_num) != over(#$num)";
918                 }
919         }
920         unless (defined($num)) {
921                 for my $mid (reverse @$mids) {
922                         # is this a number we got before?
923                         my $n = $sync->{mm_tmp}->num_for($mid);
924                         next unless defined $n;
925                         next if defined($regen_num) && $regen_num != $n;
926                         ($num, $mid0) = ($n, $mid);
927                         last;
928                 }
929         }
930         if (defined($num)) {
931                 $sync->{mm_tmp}->num_delete($num);
932         } elsif (defined $regen_num) {
933                 $num = $regen_num;
934                 for my $mid (reverse @$mids) {
935                         $self->{mm}->mid_set($num, $mid) == 1 or next;
936                         $mid0 = $mid;
937                         last;
938                 }
939                 unless (defined $mid0) {
940                         warn "E: cannot regen #$num\n";
941                         return;
942                 }
943         } else { # fixup bugs in old mirrors on reindex
944                 for my $mid (reverse @$mids) {
945                         $num = $self->{mm}->mid_insert($mid);
946                         next unless defined $num;
947                         $mid0 = $mid;
948                         last;
949                 }
950                 if (defined $mid0) {
951                         if ($sync->{reindex}) {
952                                 warn "reindex added #$num <$mid0>\n";
953                         }
954                 } else {
955                         warn "E: cannot find article #\n";
956                         return;
957                 }
958         }
959         $sync->{nr}++;
960         my $smsg = bless {
961                 bytes => $len,
962                 num => $num,
963                 blob => $oid,
964                 mid => $mid0,
965         }, 'PublicInbox::Smsg';
966         if (do_idx($self, $msgref, $mime, $smsg)) {
967                 reindex_checkpoint($self, $sync, $git);
968         }
969 }
970
971 sub check_unindexed ($$$) {
972         my ($self, $num, $mid0) = @_;
973         my $unindexed = $self->{unindexed} // {};
974         my $n = delete($unindexed->{$mid0});
975         defined $n or return;
976         if ($n != $num) {
977                 die "BUG: unindexed $n != $num <$mid0>\n";
978         } else {
979                 $self->{mm}->mid_set($num, $mid0);
980         }
981 }
982
983 # reuse Msgmap to store num => oid mapping (rather than num => mid)
984 sub multi_mid_q_new () {
985         my ($fh, $fn) = tempfile('multi_mid-XXXXXXX', EXLOCK => 0, TMPDIR => 1);
986         my $multi_mid = PublicInbox::Msgmap->new_file($fn, 1);
987         $multi_mid->{dbh}->do('PRAGMA synchronous = OFF');
988         # for Msgmap->DESTROY:
989         $multi_mid->{tmp_name} = $fn;
990         $multi_mid->{pid} = $$;
991         close $fh or die "failed to close $fn: $!";
992         $multi_mid
993 }
994
995 sub multi_mid_q_push ($$$) {
996         my ($self, $sync, $oid) = @_;
997         my $multi_mid = $sync->{multi_mid} //= PublicInbox::MultiMidQueue->new;
998         if ($sync->{reindex}) { # no regen on reindex
999                 $multi_mid->push_oid($oid, $self);
1000         } else {
1001                 my $num = $sync->{regen}--;
1002                 die "BUG: ran out of article numbers" if $num <= 0;
1003                 $multi_mid->set_oid($num, $oid, $self);
1004         }
1005 }
1006
1007 sub reindex_oid ($$$$) {
1008         my ($self, $sync, $git, $oid) = @_;
1009         my ($num, $mid0, $len);
1010         my $msgref = $git->cat_file($oid, \$len);
1011         return if $len == 0; # purged
1012         my $mime = PublicInbox::MIME->new($$msgref);
1013         my $mids = mids($mime->header_obj);
1014         my $cid = content_id($mime);
1015
1016         if (scalar(@$mids) == 0) {
1017                 warn "E: $oid has no Message-ID, skipping\n";
1018                 return;
1019         } elsif (scalar(@$mids) == 1) {
1020                 my $mid = $mids->[0];
1021
1022                 # was the file previously marked as deleted?, skip if so
1023                 if (delete($sync->{D}->{"$mid\0$cid"})) {
1024                         if (!$sync->{reindex}) {
1025                                 $num = $sync->{regen}--;
1026                                 $self->{mm}->num_highwater($num);
1027                         }
1028                         return;
1029                 }
1030
1031                 # is this a number we got before?
1032                 $num = $sync->{mm_tmp}->num_for($mid);
1033                 if (defined $num) {
1034                         $mid0 = $mid;
1035                         check_unindexed($self, $num, $mid0);
1036                 } else {
1037                         $num = $sync->{regen}--;
1038                         die "BUG: ran out of article numbers" if $num <= 0;
1039                         if ($self->{mm}->mid_set($num, $mid) != 1) {
1040                                 warn "E: unable to assign $num => <$mid>\n";
1041                                 return;
1042                         }
1043                         $mid0 = $mid;
1044                 }
1045         } else { # multiple MIDs are a weird case:
1046                 my $del = 0;
1047                 for (@$mids) {
1048                         $del += delete($sync->{D}->{"$_\0$cid"}) // 0;
1049                 }
1050                 if ($del) {
1051                         unindex_oid_remote($self, $oid, $_) for @$mids;
1052                         # do not delete from {mm_tmp}, since another
1053                         # single-MID message may use it.
1054                 } else { # handle them at the end:
1055                         multi_mid_q_push($self, $sync, $oid);
1056                 }
1057                 return;
1058         }
1059         $sync->{mm_tmp}->mid_delete($mid0) or
1060                 die "failed to delete <$mid0> for article #$num\n";
1061         $sync->{nr}++;
1062         my $smsg = bless {
1063                 bytes => $len,
1064                 num => $num,
1065                 blob => $oid,
1066                 mid => $mid0,
1067         }, 'PublicInbox::Smsg';
1068         if (do_idx($self, $msgref, $mime, $smsg)) {
1069                 reindex_checkpoint($self, $sync, $git);
1070         }
1071 }
1072
1073 # only update last_commit for $i on reindex iff newer than current
1074 sub update_last_commit ($$$$) {
1075         my ($self, $git, $i, $cmt) = @_;
1076         my $last = last_epoch_commit($self, $i);
1077         if (defined $last && is_ancestor($git, $last, $cmt)) {
1078                 my @cmd = (qw(rev-list --count), "$last..$cmt");
1079                 chomp(my $n = $git->qx(@cmd));
1080                 return if $n ne '' && $n == 0;
1081         }
1082         last_epoch_commit($self, $i, $cmt);
1083 }
1084
1085 sub git_dir_n ($$) { "$_[0]->{-inbox}->{inboxdir}/git/$_[1].git" }
1086
1087 sub last_commits ($$) {
1088         my ($self, $epoch_max) = @_;
1089         my $heads = [];
1090         for (my $i = $epoch_max; $i >= 0; $i--) {
1091                 $heads->[$i] = last_epoch_commit($self, $i);
1092         }
1093         $heads;
1094 }
1095
1096 *is_ancestor = *PublicInbox::SearchIdx::is_ancestor;
1097
1098 # returns a revision range for git-log(1)
1099 sub log_range ($$$$$) {
1100         my ($self, $sync, $git, $i, $tip) = @_;
1101         my $opt = $sync->{-opt};
1102         my $pr = $opt->{-progress} if (($opt->{verbose} || 0) > 1);
1103         my $cur = $sync->{ranges}->[$i] or do {
1104                 $pr->("$i.git indexing all of $tip") if $pr;
1105                 return $tip; # all of it
1106         };
1107
1108         # fast equality check to avoid (v)fork+execve overhead
1109         if ($cur eq $tip) {
1110                 $sync->{ranges}->[$i] = undef;
1111                 return;
1112         }
1113
1114         my $range = "$cur..$tip";
1115         $pr->("$i.git checking contiguity... ") if $pr;
1116         if (is_ancestor($git, $cur, $tip)) { # common case
1117                 $pr->("OK\n") if $pr;
1118                 my $n = $git->qx(qw(rev-list --count), $range);
1119                 chomp($n);
1120                 if ($n == 0) {
1121                         $sync->{ranges}->[$i] = undef;
1122                         $pr->("$i.git has nothing new\n") if $pr;
1123                         return; # nothing to do
1124                 }
1125                 $pr->("$i.git has $n changes since $cur\n") if $pr;
1126         } else {
1127                 $pr->("FAIL\n") if $pr;
1128                 warn <<"";
1129 discontiguous range: $range
1130 Rewritten history? (in $git->{git_dir})
1131
1132                 chomp(my $base = $git->qx('merge-base', $tip, $cur));
1133                 if ($base) {
1134                         $range = "$base..$tip";
1135                         warn "found merge-base: $base\n"
1136                 } else {
1137                         $range = $tip;
1138                         warn "discarding history at $cur\n";
1139                 }
1140                 warn <<"";
1141 reindexing $git->{git_dir} starting at
1142 $range
1143
1144                 $sync->{unindex_range}->{$i} = "$base..$cur";
1145         }
1146         $range;
1147 }
1148
1149 sub sync_prepare ($$$) {
1150         my ($self, $sync, $epoch_max) = @_;
1151         my $pr = $sync->{-opt}->{-progress};
1152         my $regen_max = 0;
1153         my $head = $self->{-inbox}->{ref_head} || 'refs/heads/master';
1154
1155         # reindex stops at the current heads and we later rerun index_sync
1156         # without {reindex}
1157         my $reindex_heads = last_commits($self, $epoch_max) if $sync->{reindex};
1158
1159         for (my $i = $epoch_max; $i >= 0; $i--) {
1160                 die 'BUG: already indexing!' if $self->{reindex_pipe};
1161                 my $git_dir = git_dir_n($self, $i);
1162                 -d $git_dir or next; # missing epochs are fine
1163                 my $git = PublicInbox::Git->new($git_dir);
1164                 if ($reindex_heads) {
1165                         $head = $reindex_heads->[$i] or next;
1166                 }
1167                 chomp(my $tip = $git->qx(qw(rev-parse -q --verify), $head));
1168
1169                 next if $?; # new repo
1170                 my $range = log_range($self, $sync, $git, $i, $tip) or next;
1171                 $sync->{ranges}->[$i] = $range;
1172
1173                 # can't use 'rev-list --count' if we use --diff-filter
1174                 $pr->("$i.git counting $range ... ") if $pr;
1175                 my $n = 0;
1176                 my $fh = $git->popen(qw(log --pretty=tformat:%H
1177                                 --no-notes --no-color --no-renames
1178                                 --diff-filter=AM), $range, '--', 'm');
1179                 ++$n while <$fh>;
1180                 close $fh or die "git log failed: \$?=$?";
1181                 $pr->("$n\n") if $pr;
1182                 $regen_max += $n;
1183         }
1184
1185         return 0 if (!$regen_max && !keys(%{$self->{unindex_range}}));
1186
1187         # reindex should NOT see new commits anymore, if we do,
1188         # it's a problem and we need to notice it via die()
1189         my $pad = length($regen_max) + 1;
1190         $sync->{-regen_fmt} = "% ${pad}u/$regen_max\n";
1191         $sync->{nr} = 0;
1192         return -1 if $sync->{reindex};
1193         $regen_max + $self->{mm}->num_highwater() || 0;
1194 }
1195
1196 sub unindex_oid_remote ($$$) {
1197         my ($self, $oid, $mid) = @_;
1198         $_->remote_remove($oid, $mid) foreach @{$self->{idx_shards}};
1199         $self->{over}->remove_oid($oid, $mid);
1200 }
1201
1202 sub unindex_oid ($$$;$) {
1203         my ($self, $git, $oid, $unindexed) = @_;
1204         my $mm = $self->{mm};
1205         my $msgref = $git->cat_file($oid);
1206         my $mime = PublicInbox::MIME->new($msgref);
1207         my $mids = mids($mime->header_obj);
1208         $mime = $msgref = undef;
1209         my $over = $self->{over};
1210         foreach my $mid (@$mids) {
1211                 my %gone;
1212                 my ($id, $prev);
1213                 while (my $smsg = $over->next_by_mid($mid, \$id, \$prev)) {
1214                         $gone{$smsg->{num}} = 1 if $oid eq $smsg->{blob};
1215                         1; # continue
1216                 }
1217                 my $n = scalar keys %gone;
1218                 next unless $n;
1219                 if ($n > 1) {
1220                         warn "BUG: multiple articles linked to $oid\n",
1221                                 join(',',sort keys %gone), "\n";
1222                 }
1223                 foreach my $num (keys %gone) {
1224                         if ($unindexed) {
1225                                 my $mid0 = $mm->mid_for($num);
1226                                 $unindexed->{$mid0} = $num;
1227                         }
1228                         $mm->num_delete($num);
1229                 }
1230                 unindex_oid_remote($self, $oid, $mid);
1231         }
1232 }
1233
1234 my $x40 = qr/[a-f0-9]{40}/;
1235 sub unindex ($$$$) {
1236         my ($self, $sync, $git, $unindex_range) = @_;
1237         my $unindexed = $self->{unindexed} ||= {}; # $mid0 => $num
1238         my $before = scalar keys %$unindexed;
1239         # order does not matter, here:
1240         my @cmd = qw(log --raw -r
1241                         --no-notes --no-color --no-abbrev --no-renames);
1242         my $fh = $self->{reindex_pipe} = $git->popen(@cmd, $unindex_range);
1243         while (<$fh>) {
1244                 /\A:\d{6} 100644 $x40 ($x40) [AM]\tm$/o or next;
1245                 unindex_oid($self, $git, $1, $unindexed);
1246         }
1247         delete $self->{reindex_pipe};
1248         close $fh or die "git log failed: \$?=$?";
1249
1250         return unless $sync->{-opt}->{prune};
1251         my $after = scalar keys %$unindexed;
1252         return if $before == $after;
1253
1254         # ensure any blob can not longer be accessed via dumb HTTP
1255         PublicInbox::Import::run_die(['git', "--git-dir=$git->{git_dir}",
1256                 qw(-c gc.reflogExpire=now gc --prune=all --quiet)]);
1257 }
1258
1259 sub sync_ranges ($$$) {
1260         my ($self, $sync, $epoch_max) = @_;
1261         my $reindex = $sync->{reindex};
1262
1263         return last_commits($self, $epoch_max) unless $reindex;
1264         return [] if ref($reindex) ne 'HASH';
1265
1266         my $ranges = $reindex->{from}; # arrayref;
1267         if (ref($ranges) ne 'ARRAY') {
1268                 die 'BUG: $reindex->{from} not an ARRAY';
1269         }
1270         $ranges;
1271 }
1272
1273 sub index_epoch ($$$) {
1274         my ($self, $sync, $i) = @_;
1275
1276         my $git_dir = git_dir_n($self, $i);
1277         die 'BUG: already reindexing!' if $self->{reindex_pipe};
1278         -d $git_dir or return; # missing epochs are fine
1279         fill_alternates($self, $i);
1280         my $git = PublicInbox::Git->new($git_dir);
1281         if (my $unindex_range = delete $sync->{unindex_range}->{$i}) {
1282                 unindex($self, $sync, $git, $unindex_range);
1283         }
1284         defined(my $range = $sync->{ranges}->[$i]) or return;
1285         if (my $pr = $sync->{-opt}->{-progress}) {
1286                 $pr->("$i.git indexing $range\n");
1287         }
1288
1289         my @cmd = qw(log --raw -r --pretty=tformat:%H.%at.%ct
1290                         --no-notes --no-color --no-abbrev --no-renames);
1291         my $fh = $self->{reindex_pipe} = $git->popen(@cmd, $range);
1292         my $cmt;
1293         while (<$fh>) {
1294                 chomp;
1295                 $self->{current_info} = "$i.git $_";
1296                 if (/\A($x40)\.([0-9]+)\.([0-9]+)$/o) {
1297                         $cmt //= $1;
1298                         $self->{autime} = $2;
1299                         $self->{cotime} = $3;
1300                 } elsif (/\A:\d{6} 100644 $x40 ($x40) [AM]\tm$/o) {
1301                         reindex_oid($self, $sync, $git, $1);
1302                 } elsif (/\A:\d{6} 100644 $x40 ($x40) [AM]\td$/o) {
1303                         mark_deleted($self, $sync, $git, $1);
1304                 }
1305         }
1306         close $fh or die "git log failed: \$?=$?";
1307         delete $self->{reindex_pipe};
1308         update_last_commit($self, $git, $i, $cmt) if defined $cmt;
1309 }
1310
1311 # public, called by public-inbox-index
1312 sub index_sync {
1313         my ($self, $opt) = @_;
1314         $opt ||= {};
1315         my $pr = $opt->{-progress};
1316         my $epoch_max;
1317         my $latest = git_dir_latest($self, \$epoch_max);
1318         return unless defined $latest;
1319         $self->idx_init($opt); # acquire lock
1320         my $sync = {
1321                 D => {}, # "$mid\0$cid" => $oid
1322                 unindex_range => {}, # EPOCH => oid_old..oid_new
1323                 reindex => $opt->{reindex},
1324                 -opt => $opt
1325         };
1326         $sync->{ranges} = sync_ranges($self, $sync, $epoch_max);
1327         $sync->{regen} = sync_prepare($self, $sync, $epoch_max);
1328
1329         if ($sync->{regen}) {
1330                 # tmp_clone seems to fail if inside a transaction, so
1331                 # we rollback here (because we opened {mm} for reading)
1332                 # Note: we do NOT rely on DBI transactions for atomicity;
1333                 # only for batch performance.
1334                 $self->{mm}->{dbh}->rollback;
1335                 $self->{mm}->{dbh}->begin_work;
1336                 $sync->{mm_tmp} = $self->{mm}->tmp_clone;
1337         }
1338
1339         # work backwards through history
1340         for (my $i = $epoch_max; $i >= 0; $i--) {
1341                 index_epoch($self, $sync, $i);
1342         }
1343
1344         # unindex is required for leftovers if "deletes" affect messages
1345         # in a previous fetch+index window:
1346         my $git;
1347         if (my @leftovers = values %{delete $sync->{D}}) {
1348                 $git = $self->{-inbox}->git;
1349                 for my $oid (@leftovers) {
1350                         $self->{current_info} = "leftover $oid";
1351                         unindex_oid($self, $git, $oid);
1352                 }
1353         }
1354         if (my $multi_mid = delete $sync->{multi_mid}) {
1355                 $git //= $self->{-inbox}->git;
1356                 my $min = $multi_mid->{min};
1357                 my $max = $multi_mid->{max};
1358                 if ($sync->{reindex}) {
1359                         # we may need to create new Message-IDs if mirrors
1360                         # were initially indexed with old versions
1361                         for (my $i = $max; $i >= $min; $i--) {
1362                                 my $oid;
1363                                 $oid = $multi_mid->get_oid($i, $self) or next;
1364                                 next unless defined $oid;
1365                                 reindex_oid_m($self, $sync, $git, $oid);
1366                         }
1367                 } else { # regen on initial index
1368                         for my $num ($min..$max) {
1369                                 my $oid;
1370                                 $oid = $multi_mid->get_oid($num, $self) or next;
1371                                 reindex_oid_m($self, $sync, $git, $oid, $num);
1372                         }
1373                 }
1374         }
1375         $git->cleanup if $git;
1376         $self->done;
1377
1378         if (my $nr = $sync->{nr}) {
1379                 my $pr = $sync->{-opt}->{-progress};
1380                 $pr->('all.git '.sprintf($sync->{-regen_fmt}, $nr)) if $pr;
1381         }
1382
1383         # reindex does not pick up new changes, so we rerun w/o it:
1384         if ($opt->{reindex}) {
1385                 my %again = %$opt;
1386                 $sync = undef;
1387                 delete @again{qw(reindex -skip_lock)};
1388                 index_sync($self, \%again);
1389         }
1390 }
1391
1392 1;