lib/PublicInbox/LeiMirror.pm

   1 # Copyright (C) all contributors <meta@public-inbox.org>
   2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
   3
   4 # "lei add-external --mirror" support (also "public-inbox-clone");
   5 package PublicInbox::LeiMirror;
   6 use v5.12;
   7 use parent qw(PublicInbox::IPC);
   8 use IO::Uncompress::Gunzip qw(gunzip $GunzipError);
   9 use IO::Compress::Gzip qw(gzip $GzipError);
  10 use PublicInbox::Spawn qw(popen_rd spawn run_die);
  11 use File::Path ();
  12 use File::Temp ();
  13 use File::Spec ();
  14 use Fcntl qw(SEEK_SET O_CREAT O_EXCL O_WRONLY);
  15 use Carp qw(croak);
  16 use URI;
  17 use PublicInbox::Config;
  18 use PublicInbox::Inbox;
  19 use PublicInbox::LeiCurl;
  20 use PublicInbox::OnDestroy;
  21 use Digest::SHA qw(sha256_hex);
  22
  23 our $LIVE; # pid => callback
  24 my $update_ref_stdin = $ENV{GIT_CAN_UPDATE_REF_STDIN} // 1;
  25
  26 sub _wq_done_wait { # dwaitpid callback (via wq_eof)
  27         my ($arg, $pid) = @_;
  28         my ($mrr, $lei) = @$arg;
  29         my $f = "$mrr->{dst}/mirror.done";
  30         if ($?) {
  31                 $lei->child_error($?);
  32         } elsif (!$mrr->{dry_run} && !unlink($f)) {
  33                 warn("unlink($f): $!\n") unless $!{ENOENT};
  34         } else {
  35                 if (!$mrr->{dry_run} && $lei->{cmd} ne 'public-inbox-clone') {
  36                         require PublicInbox::LeiAddExternal;
  37                         PublicInbox::LeiAddExternal::_finish_add_external(
  38                                                         $lei, $mrr->{dst});
  39                 }
  40                 $lei->qerr("# mirrored $mrr->{src} => $mrr->{dst}");
  41         }
  42         $lei->dclose;
  43 }
  44
  45 # for old installations without manifest.js.gz
  46 sub try_scrape {
  47         my ($self, $fallback_manifest) = @_;
  48         my $uri = URI->new($self->{src});
  49         my $lei = $self->{lei};
  50         my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
  51         my $cmd = $curl->for_uri($lei, $uri, qw(-f --compressed));
  52         my $opt = { 0 => $lei->{0}, 2 => $lei->{2} };
  53         my $fh = popen_rd($cmd, undef, $opt);
  54         my $html = do { local $/; <$fh> } // die "read(curl $uri): $!";
  55         close($fh) or return $lei->child_error($?, "@$cmd failed");
  56
  57         # we grep with URL below, we don't want Subject/From headers
  58         # making us clone random URLs.  This assumes remote instances
  59         # prior to public-inbox 1.7.0
  60         # 5b96edcb1e0d8252 (www: move mirror instructions to /text/, 2021-08-28)
  61         my @html = split(/<hr>/, $html);
  62         my @urls = ($html[-1] =~ m!\bgit clone --mirror ([a-z\+]+://\S+)!g);
  63         if (!@urls && $fallback_manifest) {
  64                 warn <<EOM;
  65 W: failed to extract URLs from $uri, trying manifest.js.gz...
  66 EOM
  67                 return start_clone_url($self);
  68         }
  69         my $url = $uri->as_string;
  70         chop($url) eq '/' or die "BUG: $uri not canonicalized";
  71
  72         # since this is for old instances w/o manifest.js.gz, try v1 first
  73         return clone_v1($self) if grep(m!\A\Q$url\E/*\z!, @urls);
  74         if (my @v2_urls = grep(m!\A\Q$url\E/[0-9]+\z!, @urls)) {
  75                 my %v2_epochs = map {
  76                         my ($n) = (m!/([0-9]+)\z!);
  77                         $n => [ URI->new($_), '' ]
  78                 } @v2_urls; # uniq
  79                 clone_v2_prep($self, \%v2_epochs);
  80                 delete local $lei->{opt}->{epoch};
  81                 clone_all($self);
  82                 return;
  83         }
  84
  85         # filter out common URLs served by WWW (e.g /$MSGID/T/)
  86         if (@urls && $url =~ s!/+[^/]+\@[^/]+/.*\z!! &&
  87                         grep(m!\A\Q$url\E/*\z!, @urls)) {
  88                 die <<"";
  89 E: confused by scraping <$uri>, did you mean <$url>?
  90
  91         }
  92         @urls and die <<"";
  93 E: confused by scraping <$uri>, got ambiguous results:
  94 @urls
  95
  96         die "E: scraping <$uri> revealed nothing\n";
  97 }
  98
  99 sub clone_cmd {
 100         my ($lei, $opt) = @_;
 101         my @cmd = qw(git);
 102         $opt->{$_} = $lei->{$_} for (0..2);
 103         # we support "-c $key=$val" for arbitrary git config options
 104         # e.g.: git -c http.proxy=socks5h://127.0.0.1:9050
 105         push(@cmd, '-c', $_) for @{$lei->{opt}->{c} // []};
 106         push @cmd, qw(clone --mirror);
 107         push @cmd, '-q' if $lei->{opt}->{quiet} ||
 108                         ($lei->{opt}->{jobs} // 1) > 1;
 109         push @cmd, '-v' if $lei->{opt}->{verbose};
 110         # XXX any other options to support?
 111         # --reference is tricky with multiple epochs, but handled
 112         # automatically if using manifest.js.gz
 113         @cmd;
 114 }
 115
 116 sub ft_rename ($$$) {
 117         my ($ft, $dst, $open_mode) = @_;
 118         my @st = stat($dst);
 119         my $mode = @st ? ($st[2] & 07777) : ($open_mode & ~umask);
 120         chmod($mode, $ft) or croak "E: chmod($ft): $!";
 121         require File::Copy;
 122         File::Copy::mv($ft->filename, $dst) or croak "E: mv($ft => $dst): $!";
 123         $ft->unlink_on_destroy(0);
 124 }
 125
 126 sub do_reap ($;$) {
 127         my ($self, $jobs) = @_;
 128         $jobs //= $self->{-jobs} //= $self->{lei}->{opt}->{jobs} // 1;
 129         $jobs = 1 if $jobs < 1;
 130         while (keys(%$LIVE) >= $jobs) {
 131                 my $pid = waitpid(-1, 0) // die "waitpid(-1): $!";
 132                 if (my $x = delete $LIVE->{$pid}) {
 133                         my $cb = shift @$x;
 134                         $cb->(@$x) if $cb;
 135                 } else {
 136                         warn "reaped unknown PID=$pid ($?)\n";
 137                 }
 138         }
 139 }
 140
 141 sub _get_txt_start { # non-fatal
 142         my ($self, $endpoint, $fini) = @_;
 143         my $uri = URI->new($self->{cur_src} // $self->{src});
 144         my $lei = $self->{lei};
 145         my $path = $uri->path;
 146         chop($path) eq '/' or die "BUG: $uri not canonicalized";
 147         $uri->path("$path/$endpoint");
 148         my $f = (split(m!/!, $endpoint))[-1];
 149         my $ft = File::Temp->new(TEMPLATE => "$f-XXXX", TMPDIR => 1);
 150         my $opt = { 0 => $lei->{0}, 1 => $lei->{1}, 2 => $lei->{2} };
 151         my $cmd = $self->{curl}->for_uri($lei, $uri, qw(-f --compressed -R -o),
 152                                         $ft->filename);
 153         do_reap($self);
 154         $lei->qerr("# @$cmd");
 155         return if $self->{dry_run};
 156         $self->{"-get_txt.$endpoint"} = [ $ft, $cmd, $uri ];
 157         $LIVE->{spawn($cmd, undef, $opt)} =
 158                         [ \&_get_txt_done, $self, $endpoint, $fini ];
 159 }
 160
 161 sub _get_txt_done { # returns true on error (non-fatal), undef on success
 162         my ($self, $endpoint) = @_;
 163         my ($fh, $cmd, $uri) = @{delete $self->{"-get_txt.$endpoint"}};
 164         my $cerr = $?;
 165         $? = 0; # don't influence normal lei exit
 166         return warn("$uri missing\n") if ($cerr >> 8) == 22;
 167         return warn("# @$cmd failed (non-fatal)\n") if $cerr;
 168         seek($fh, SEEK_SET, 0) or die "seek: $!";
 169         $self->{"mtime.$endpoint"} = (stat($fh))[9];
 170         local $/;
 171         $self->{"txt.$endpoint"} = <$fh>;
 172         undef; # success
 173 }
 174
 175 sub _write_inbox_config {
 176         my ($self) = @_;
 177         my $buf = delete($self->{'txt._/text/config/raw'}) // return;
 178         my $dst = $self->{cur_dst} // $self->{dst};
 179         my $f = "$dst/inbox.config.example";
 180         open my $fh, '>', $f or die "open($f): $!";
 181         print $fh $buf or die "print: $!";
 182         chmod(0444 & ~umask, $fh) or die "chmod($f): $!";
 183         my $mtime = delete $self->{'mtime._/text/config/raw'};
 184         $fh->flush or die "flush($f): $!";
 185         if (defined $mtime) {
 186                 utime($mtime, $mtime, $fh) or die "utime($f): $!";
 187         }
 188         my $cfg = PublicInbox::Config->git_config_dump($f, $self->{lei}->{2});
 189         my $ibx = $self->{ibx} = {};
 190         for my $sec (grep(/\Apublicinbox\./, @{$cfg->{-section_order}})) {
 191                 for (qw(address newsgroup nntpmirror)) {
 192                         $ibx->{$_} = $cfg->{"$sec.$_"};
 193                 }
 194         }
 195 }
 196
 197 sub set_description ($) {
 198         my ($self) = @_;
 199         my $dst = $self->{cur_dst} // $self->{dst};
 200         my $f = "$dst/description";
 201         open my $fh, '+>>', $f or die "open($f): $!";
 202         seek($fh, 0, SEEK_SET) or die "seek($f): $!";
 203         my $d = do { local $/; <$fh> } // die "read($f): $!";
 204         chomp(my $orig = $d);
 205         while (defined($d) && ($d =~ m!^\(\$INBOX_DIR/description missing\)! ||
 206                         $d =~ /^Unnamed repository/ || $d !~ /\S/)) {
 207                 $d = delete($self->{'txt.description'});
 208         }
 209         $d //= 'mirror of '.($self->{cur_src} // $self->{src});
 210         chomp $d;
 211         return if $d eq $orig;
 212         seek($fh, 0, SEEK_SET) or die "seek($f): $!";
 213         truncate($fh, 0) or die "truncate($f): $!";
 214         print $fh $d, "\n" or die "print($f): $!";
 215         close $fh or die "close($f): $!";
 216 }
 217
 218 sub index_cloned_inbox {
 219         my ($self, $iv) = @_;
 220         my $lei = $self->{lei};
 221         eval { set_description($self) };
 222         warn $@ if $@;
 223
 224         # n.b. public-inbox-clone works w/o (SQLite || Xapian)
 225         # lei is useless without Xapian + SQLite
 226         if ($lei->{cmd} ne 'public-inbox-clone') {
 227                 require PublicInbox::InboxWritable;
 228                 require PublicInbox::Admin;
 229                 my $ibx = delete($self->{ibx}) // {
 230                         address => [ 'lei@example.com' ],
 231                         version => $iv,
 232                 };
 233                 $ibx->{inboxdir} = $self->{cur_dst} // $self->{dst};
 234                 PublicInbox::Inbox->new($ibx);
 235                 PublicInbox::InboxWritable->new($ibx);
 236                 my $opt = {};
 237                 for my $sw ($lei->index_opt) {
 238                         my ($k) = ($sw =~ /\A([\w-]+)/);
 239                         $opt->{$k} = $lei->{opt}->{$k};
 240                 }
 241                 # force synchronous dwaitpid for v2:
 242                 local $PublicInbox::DS::in_loop = 0;
 243                 my $cfg = PublicInbox::Config->new(undef, $lei->{2});
 244                 my $env = PublicInbox::Admin::index_prepare($opt, $cfg);
 245                 local %ENV = (%ENV, %$env) if $env;
 246                 PublicInbox::Admin::progress_prepare($opt, $lei->{2});
 247                 PublicInbox::Admin::index_inbox($ibx, undef, $opt);
 248         }
 249         return if defined $self->{cur_dst}; # one of many repos to clone
 250         open my $x, '>', "$self->{dst}/mirror.done"; # for _wq_done_wait
 251 }
 252
 253 sub run_reap {
 254         my ($lei, $cmd, $opt) = @_;
 255         $lei->qerr("# @$cmd");
 256         waitpid(spawn($cmd, undef, $opt), 0) // die "waitpid: $!";
 257         my $ret = $?;
 258         $? = 0; # don't let it influence normal exit
 259         $ret;
 260 }
 261
 262 sub start_clone {
 263         my ($self, $cmd, $opt, $fini) = @_;
 264         do_reap($self);
 265         $self->{lei}->qerr("# @$cmd");
 266         return if $self->{dry_run};
 267         $LIVE->{spawn($cmd, undef, $opt)} = [ \&reap_cmd, $self, $cmd, $fini ]
 268 }
 269
 270 sub fetch_args ($$) {
 271         my ($lei, $opt) = @_;
 272         my @cmd; # (git --git-dir=...) to be added by caller
 273         $opt->{$_} = $lei->{$_} for (0..2);
 274         # we support "-c $key=$val" for arbitrary git config options
 275         # e.g.: git -c http.proxy=socks5h://127.0.0.1:9050
 276         push(@cmd, '-c', $_) for @{$lei->{opt}->{c} // []};
 277         push @cmd, 'fetch';
 278         push @cmd, '-q' if $lei->{opt}->{quiet} ||
 279                         ($lei->{opt}->{jobs} // 1) > 1;
 280         push @cmd, '-v' if $lei->{opt}->{verbose};
 281         @cmd;
 282 }
 283
 284 sub fgrp_update_old ($) { # for git <1.8.5
 285         my ($fgrp) = @_;
 286         my $cmd = [ 'git', "--git-dir=$fgrp->{cur_dst}",
 287                 fetch_args($fgrp->{lei}, my $opt = {}) ];
 288         $fgrp->{lei}->qerr("# @$cmd");
 289         do_reap($fgrp);
 290         $LIVE->{spawn($cmd, undef, $opt)} = [ \&reap_cmd, $fgrp, $cmd ];
 291 }
 292
 293 sub upr { # feed `git update-ref --stdin -z' verbosely
 294         my ($fgrp, $w, $op, $ref, $oid) = @_;
 295         $fgrp->{lei}->qerr("# $op $ref $oid");
 296         print $w "$op $ref\0$oid\0" or die "print(w): $!";
 297 }
 298
 299 sub fgrp_update {
 300         my ($fgrp) = @_;
 301         my $srcfh = delete $fgrp->{srcfh} or return;
 302         my $dstfh = delete $fgrp->{dstfh} or return;
 303         seek($srcfh, SEEK_SET, 0) or die "seek(src): $!";
 304         seek($dstfh, SEEK_SET, 0) or die "seek(dst): $!";
 305         my %src = map { chomp; split(/\0/) } (<$srcfh>);
 306         close $srcfh;
 307         my %dst = map { chomp; split(/\0/) } (<$dstfh>);
 308         close $dstfh;
 309         pipe(my ($r, $w)) or die "pipe: $!";
 310         my $cmd = [ 'git', "--git-dir=$fgrp->{cur_dst}",
 311                 qw(update-ref --stdin -z) ];
 312         $fgrp->{lei}->qerr("# @$cmd");
 313         my $opt = { 0 => $r, 1 => $fgrp->{lei}->{1}, 2 => $fgrp->{lei}->{2} };
 314         my $pid = spawn($cmd, undef, $opt);
 315         close $r or die "close(r): $!";
 316         for my $ref (keys %dst) {
 317                 my $new = delete $src{$ref};
 318                 my $old = $dst{$ref};
 319                 if (defined $new) {
 320                         upr($fgrp, $w, 'update', $ref, $new) if $new ne $old;
 321                 } else {
 322                         upr($fgrp, $w, 'delete', $ref, $old);
 323                 }
 324         }
 325         while (my ($ref, $oid) = each %src) {
 326                 upr($fgrp, $w, 'create', $ref, $oid);
 327         }
 328         if (close($w)) { # git >= 1.8.5
 329                 $LIVE->{$pid} = [ \&reap_cmd, $fgrp, $cmd ];
 330                 do_reap($fgrp);
 331         } else { # git <1.8.5 w/o update-ref --stdin
 332                 warn "E: close(update-ref --stdin): $!\n";
 333                 $update_ref_stdin = 0;
 334                 waitpid($pid, 0) // die "waitpid(update-ref --stdin): $!";
 335                 fgrp_update_old($fgrp);
 336         }
 337 }
 338
 339 sub fgrp_fetched {
 340         my ($fgrp) = @_;
 341         return if $fgrp->{dry_run} || !$LIVE;
 342         my $rn = $fgrp->{-remote};
 343         my %opt = map { $_ => $fgrp->{lei}->{$_} } (0..2);
 344         my $cmd = [ 'git', "--git-dir=$fgrp->{-osdir}",
 345                         qw(pack-refs --all --prune) ];
 346         do_reap($fgrp);
 347         $fgrp->{lei}->qerr("# @$cmd");
 348         $LIVE->{spawn($cmd, undef, \%opt)} = [ \&reap_cmd, $fgrp, $cmd ];
 349
 350         $update_ref_stdin or return fgrp_update_old($fgrp);
 351
 352         my $update_ref = PublicInbox::OnDestroy->new($$, \&fgrp_update, $fgrp);
 353
 354         my $src = [ 'git', "--git-dir=$fgrp->{-osdir}", 'for-each-ref',
 355                 "--format=refs/%(refname:lstrip=3)%00%(objectname)",
 356                 "refs/remotes/$rn/" ];
 357         do_reap($fgrp);
 358         open($fgrp->{srcfh}, '+>', undef) or die "open(src): $!";
 359         $fgrp->{lei}->qerr("# @$src >SRC");
 360         my $pid = spawn($src, undef, { %opt, 1 => $fgrp->{srcfh} });
 361         $LIVE->{$pid} = [ \&reap_cmd, $fgrp, $src, $update_ref ];
 362
 363         my $dst = [ 'git', "--git-dir=$fgrp->{cur_dst}", 'for-each-ref',
 364                 '--format=%(refname)%00%(objectname)' ];
 365         do_reap($fgrp);
 366         open($fgrp->{dstfh}, '+>', undef) or die "open(dst): $!";
 367         $fgrp->{lei}->qerr("# @$dst >DST");
 368         $pid = spawn($dst, undef, { %opt, 1 => $fgrp->{dstfh} });
 369         $LIVE->{$pid} = [ \&reap_cmd, $fgrp, $dst, $update_ref ];
 370 }
 371
 372 sub fgrp_fetch {
 373         my ($fgrp, $pfx, $fini) = @_;
 374         my $cmd = [ @$pfx, 'git', "--git-dir=$fgrp->{-osdir}",
 375                         fetch_args($fgrp->{lei}, my $opt = {}),
 376                         $fgrp->{-remote} ];
 377         $fgrp->{-fini} = $fini;
 378         do_reap($fgrp);
 379         $fgrp->{lei}->qerr("# @$cmd");
 380         return if $fgrp->{dry_run};
 381         my $fgrp_fini = PublicInbox::OnDestroy->new($$, \&fgrp_fetched, $fgrp);
 382         my $pid = spawn($cmd, undef, $opt);
 383         $LIVE->{$pid} = [ \&reap_cmd, $fgrp, $cmd, $fgrp_fini ];
 384 }
 385
 386 # keep this idempotent for future use by public-inbox-fetch
 387 sub forkgroup_prep {
 388         my ($self, $uri) = @_;
 389         $self->{-ent} // return;
 390         my $os = $self->{-objstore} // return;
 391         my $fg = $self->{-ent}->{forkgroup} // return;
 392         my $dir = "$os/$fg.git";
 393         my @cmd = ('git', "--git-dir=$dir", 'config');
 394         my $opt = +{ map { $_ => $self->{lei}->{$_} } (0..2) };
 395         if (!-d $dir) {
 396                 PublicInbox::Import::init_bare($dir);
 397                 for ('repack.useDeltaIslands=true',
 398                                 'pack.island=refs/remotes/([^/]+)/') {
 399                         run_die([@cmd, split(/=/, $_, 2)], undef, $opt);
 400                 }
 401         }
 402         my $key = $self->{-key} // die 'BUG: no -key';
 403         my ($bn) = ($key =~ m{/([a-z0-9_,;=!\+\{\}\|][^/]*)(?:\.git)?\z}i);
 404         my $rn = "$bn-".substr(sha256_hex($key), 0, 16);
 405         for ("url=$uri", "fetch=+refs/*:refs/remotes/$rn/*") {
 406                 my @kv = split(/=/, $_, 2);
 407                 $kv[0] = "remote.$rn.$kv[0]";
 408                 run_die([@cmd, @kv], undef, $opt);
 409         }
 410         if (!-d $self->{cur_dst}) {
 411                 my $alt = File::Spec->rel2abs("$dir/objects");
 412                 PublicInbox::Import::init_bare($self->{cur_dst});
 413                 my $o = "$self->{cur_dst}/objects";
 414                 my $f = "$o/info/alternates";
 415                 my $l = File::Spec->abs2rel($alt, File::Spec->rel2abs($o));
 416                 open my $fh, '+>>', $f or die "open($f): $!";
 417                 seek($fh, SEEK_SET, 0) or die "seek($f): $!";
 418                 chomp(my @cur = <$fh>);
 419                 if (!grep(/\A\Q$l\E\z/, @cur)) {
 420                         say $fh $l or die "say($f): $!";
 421                 }
 422                 close $fh or die "close($f): $!";
 423                 @cmd = ('git', "--git-dir=$self->{cur_dst}",
 424                         qw(remote add --mirror=fetch origin), "$uri");
 425                 my $pid = spawn(\@cmd, undef, $opt);
 426                 waitpid($pid, 0) // die "waitpid(@cmd): $!";
 427                 die "E: @cmd: \$?=$?" if ($? && ($? >> 8) != 3);
 428         }
 429         bless { %$self, -osdir => $dir, -remote => $rn }, __PACKAGE__;
 430 }
 431
 432 sub clone_v1 {
 433         my ($self, $nohang) = @_;
 434         my $lei = $self->{lei};
 435         my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
 436         my $uri = URI->new($self->{cur_src} // $self->{src});
 437         defined($lei->{opt}->{epoch}) and
 438                 die "$uri is a v1 inbox, --epoch is not supported\n";
 439         my $pfx = $curl->torsocks($lei, $uri) or return;
 440         my $dst = $self->{cur_dst} // $self->{dst};
 441         my $fini = PublicInbox::OnDestroy->new($$, \&v1_done, $self);
 442         my $cmd = [ @$pfx, clone_cmd($lei, my $opt = {}), "$uri", $dst ];
 443         my $fgrp = forkgroup_prep($self, $uri);
 444         if (!defined($fgrp) && defined($self->{-ent})) {
 445                 if (defined(my $ref = $self->{-ent}->{reference})) {
 446                         -e "$self->{dst}$ref" and
 447                                 push @$cmd, '--reference', "$self->{dst}$ref";
 448                 }
 449         }
 450         $fgrp ? fgrp_fetch($fgrp, $pfx, $fini) :
 451                 start_clone($self, $cmd, $opt, $fini);
 452
 453         if (!$self->{-is_epoch} && $lei->{opt}->{'inbox-config'} =~
 454                                 /\A(?:always|v1)\z/s) {
 455                 _get_txt_start($self, '_/text/config/raw', $fini);
 456         }
 457
 458         my $d = $self->{-ent} ? $self->{-ent}->{description} : undef;
 459         $self->{'txt.description'} = $d if defined $d;
 460         (!defined($d) && !$nohang) and
 461                 _get_txt_start($self, 'description', $fini);
 462
 463         $nohang or do_reap($self, 1); # for non-manifest clone
 464 }
 465
 466 sub parse_epochs ($$) {
 467         my ($opt_epochs, $v2_epochs) = @_; # $epochs "LOW..HIGH"
 468         $opt_epochs // return; # undef => all epochs
 469         my ($lo, $dotdot, $hi, @extra) = split(/(\.\.)/, $opt_epochs);
 470         undef($lo) if ($lo // '') eq '';
 471         my $re = qr/\A~?[0-9]+\z/;
 472         if (@extra || (($lo // '0') !~ $re) ||
 473                         (($hi // '0') !~ $re) ||
 474                         !(grep(defined, $lo, $hi))) {
 475                 die <<EOM;
 476 --epoch=$opt_epochs not in the form of `LOW..HIGH', `LOW..', nor `..HIGH'
 477 EOM
 478         }
 479         my @n = sort { $a <=> $b } keys %$v2_epochs;
 480         for (grep(defined, $lo, $hi)) {
 481                 if (/\A[0-9]+\z/) {
 482                         $_ > $n[-1] and die
 483 "`$_' exceeds maximum available epoch ($n[-1])\n";
 484                         $_ < $n[0] and die
 485 "`$_' is lower than minimum available epoch ($n[0])\n";
 486                 } elsif (/\A~([0-9]+)/) {
 487                         my $off = -$1 - 1;
 488                         $n[$off] // die "`$_' is out of range\n";
 489                         $_ = $n[$off];
 490                 } else { die "`$_' not understood\n" }
 491         }
 492         defined($lo) && defined($hi) && $lo > $hi and die
 493 "low value (`$lo') exceeds high (`$hi')\n";
 494         $lo //= $n[0] if $dotdot;
 495         $hi //= $n[-1] if $dotdot;
 496         $hi //= $lo;
 497         my $want = {};
 498         for ($lo..$hi) {
 499                 if (defined $v2_epochs->{$_}) {
 500                         $want->{$_} = 1;
 501                 } else {
 502                         warn
 503 "# epoch $_ is not available (non-fatal, $lo..$hi)\n";
 504                 }
 505         }
 506         $want
 507 }
 508
 509 sub init_placeholder ($$$) {
 510         my ($src, $edst, $ent) = @_;
 511         PublicInbox::Import::init_bare($edst);
 512         my $f = "$edst/config";
 513         open my $fh, '>>', $f or die "open($f): $!";
 514         print $fh <<EOM or die "print($f): $!";
 515 [remote "origin"]
 516         url = $src
 517         fetch = +refs/*:refs/*
 518         mirror = true
 519
 520 ; This git epoch was created read-only and "public-inbox-fetch"
 521 ; will not fetch updates for it unless write permission is added.
 522 ; Hint: chmod +w $edst
 523 EOM
 524         if (defined($ent->{owner})) {
 525                 print $fh <<EOM or die "print($f): $!";
 526 [gitweb]
 527         owner = $ent->{owner}
 528 EOM
 529         }
 530         close $fh or die "close($f): $!";
 531         my %map = (head => 'HEAD', description => undef);
 532         while (my ($key, $fn) = each %map) {
 533                 my $val = $ent->{$key} // next;
 534                 $fn //= $key;
 535                 $fn = "$edst/$fn";
 536                 open $fh, '>', $fn or die "open($fn): $!";
 537                 print $fh $val, "\n" or die "print($fn): $!";
 538                 close $fh or die "close($fn): $!";
 539         }
 540 }
 541
 542 sub reap_cmd { # async, called via SIGCHLD
 543         my ($self, $cmd) = @_;
 544         my $cerr = $?;
 545         $? = 0; # don't let it influence normal exit
 546         if ($cerr) {
 547                 kill('TERM', keys %$LIVE);
 548                 $self->{lei}->child_error($cerr, "@$cmd failed");
 549         }
 550 }
 551
 552 sub v1_done { # called via OnDestroy
 553         my ($self) = @_;
 554         return if $self->{dry_run} || !$LIVE;
 555         _write_inbox_config($self);
 556         my $dst = $self->{cur_dst} // $self->{dst};
 557         if (defined(my $o = $self->{-ent} ? $self->{-ent}->{owner} : undef)) {
 558                 run_die([qw(git config -f), "$dst/config", 'gitweb.owner', $o]);
 559         }
 560         my $o = "$dst/objects";
 561         if (open(my $fh, '<', "$o/info/alternates")) {
 562                 my $base = File::Spec->rel2abs($o);
 563                 chomp(my @l = <$fh>);
 564                 for (@l) {
 565                         $_ = File::Spec->abs2rel($_, $base) if m!\A/!;
 566                         $_ .= "\n";
 567                 }
 568                 my $f = File::Temp->new(TEMPLATE => '.XXXX', DIR => "$o/info");
 569                 print $f @l;
 570                 $f->flush or die "flush($f): $!";
 571                 rename($f->filename, "$o/info/alternates") or
 572                         die "rename($f, $o/info/alternates): $!";
 573                 $f->unlink_on_destroy(0);
 574         }
 575         return if ($self->{-is_epoch} ||
 576                 $self->{lei}->{opt}->{'inbox-config'} ne 'always');
 577         write_makefile($dst, 1);
 578         index_cloned_inbox($self, 1);
 579 }
 580
 581 sub v2_done { # called via OnDestroy
 582         my ($self) = @_;
 583         return if $self->{dry_run} || !$LIVE;
 584         my $dst = $self->{cur_dst} // $self->{dst};
 585         require PublicInbox::Lock;
 586         my $lk = bless { lock_path => "$dst/inbox.lock" }, 'PublicInbox::Lock';
 587         my $lck = $lk->lock_for_scope($$);
 588         _write_inbox_config($self);
 589         require PublicInbox::MultiGit;
 590         my $mg = PublicInbox::MultiGit->new($dst, 'all.git', 'git');
 591         $mg->fill_alternates;
 592         for my $i ($mg->git_epochs) { $mg->epoch_cfg_set($i) }
 593         for my $edst (@{delete($self->{-read_only}) // []}) {
 594                 my @st = stat($edst) or die "stat($edst): $!";
 595                 chmod($st[2] & 0555, $edst) or die "chmod(a-w, $edst): $!";
 596         }
 597         write_makefile($dst, 2);
 598         undef $lck; # unlock
 599         index_cloned_inbox($self, 2);
 600 }
 601
 602 sub clone_v2_prep ($$;$) {
 603         my ($self, $v2_epochs, $m) = @_; # $m => manifest.js.gz hashref
 604         my $lei = $self->{lei};
 605         my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
 606         my $first_uri = (map { $_->[0] } values %$v2_epochs)[0];
 607         my $pfx = $curl->torsocks($lei, $first_uri) or return;
 608         my $dst = $self->{cur_dst} // $self->{dst};
 609         my $want = parse_epochs($lei->{opt}->{epoch}, $v2_epochs);
 610         my $task = $m ? bless { %$self }, __PACKAGE__ : $self;
 611         delete $task->{todo}; # $self->{todo} still exists
 612         my (@skip, $desc);
 613         my $fini = PublicInbox::OnDestroy->new($$, \&v2_done, $task);
 614         for my $nr (sort { $a <=> $b } keys %$v2_epochs) {
 615                 my ($uri, $key) = @{$v2_epochs->{$nr}};
 616                 my $src = $uri->as_string;
 617                 my $edst = $dst;
 618                 $src =~ m!/([0-9]+)(?:\.git)?\z! or die <<"";
 619 failed to extract epoch number from $src
 620
 621                 $1 + 0 == $nr or die "BUG: <$uri> miskeyed $1 != $nr";
 622                 $edst .= "/git/$nr.git";
 623                 my $ent;
 624                 if ($m) {
 625                         $ent = $m->{$key} //
 626                                 die("BUG: `$key' not in manifest.js.gz");
 627                         if (defined(my $d = $ent->{description})) {
 628                                 $d =~ s/ \[epoch [0-9]+\]\z//s;
 629                                 $desc = $d;
 630                         }
 631                 }
 632                 if (!$want || $want->{$nr}) {
 633                         my $etask = bless { %$task, -key => $key }, __PACKAGE__;
 634                         $etask->{-ent} = $ent; # may have {reference}
 635                         $etask->{cur_src} = $src;
 636                         $etask->{cur_dst} = $edst;
 637                         $etask->{-is_epoch} = $fini;
 638                         my $ref = $ent->{reference} // '';
 639                         push @{$self->{todo}->{$ref}}, $etask;
 640                         $self->{any_want}->{$key} = 1;
 641                 } else { # create a placeholder so users only need to chmod +w
 642                         init_placeholder($src, $edst, $ent);
 643                         push @{$task->{-read_only}}, $edst;
 644                         push @skip, $key;
 645                 }
 646         }
 647         # filter out the epochs we skipped
 648         $self->{-culled_manifest} = 1 if $m && delete(@$m{@skip});
 649
 650         (!$self->{dry_run} && !-d $dst) and File::Path::mkpath($dst);
 651
 652         $lei->{opt}->{'inbox-config'} =~ /\A(?:always|v2)\z/s and
 653                 _get_txt_start($task, '_/text/config/raw', $fini);
 654
 655         defined($desc) ? ($task->{'txt.description'} = $desc) :
 656                 _get_txt_start($task, 'description', $fini);
 657 }
 658
 659 sub decode_manifest ($$$) {
 660         my ($fh, $fn, $uri) = @_;
 661         my $js;
 662         my $gz = do { local $/; <$fh> } // die "slurp($fn): $!";
 663         gunzip(\$gz => \$js, MultiStream => 1) or
 664                 die "gunzip($uri): $GunzipError\n";
 665         my $m = eval { PublicInbox::Config->json->decode($js) };
 666         die "$uri: error decoding `$js': $@\n" if $@;
 667         ref($m) eq 'HASH' or die "$uri unknown type: ".ref($m);
 668         $m;
 669 }
 670
 671 sub multi_inbox ($$$) {
 672         my ($self, $path, $m) = @_;
 673         my $incl = $self->{lei}->{opt}->{include};
 674         my $excl = $self->{lei}->{opt}->{exclude};
 675
 676         # assuming everything not v2 is v1, for now
 677         my @v1 = sort grep(!m!.+/git/[0-9]+\.git\z!, keys %$m);
 678         my @v2_epochs = sort grep(m!.+/git/[0-9]+\.git\z!, keys %$m);
 679         my $v2 = {};
 680
 681         for (@v2_epochs) {
 682                 m!\A(/.+)/git/[0-9]+\.git\z! or die "BUG: $_";
 683                 push @{$v2->{$1}}, $_;
 684         }
 685         my $n = scalar(keys %$v2) + scalar(@v1);
 686         my @orig = defined($incl // $excl) ? (keys %$v2, @v1) : ();
 687         if (defined $incl) {
 688                 my $re = '(?:'.join('\\z|', map {
 689                                 $self->{lei}->glob2re($_) // qr/\A\Q$_\E/
 690                         } @$incl).'\\z)';
 691                 my @gone = delete @$v2{grep(!/$re/, keys %$v2)};
 692                 delete @$m{map { @$_ } @gone} and $self->{-culled_manifest} = 1;
 693                 delete @$m{grep(!/$re/, @v1)} and $self->{-culled_manifest} = 1;
 694                 @v1 = grep(/$re/, @v1);
 695         }
 696         if (defined $excl) {
 697                 my $re = '(?:'.join('\\z|', map {
 698                                 $self->{lei}->glob2re($_) // qr/\A\Q$_\E/
 699                         } @$excl).'\\z)';
 700                 my @gone = delete @$v2{grep(/$re/, keys %$v2)};
 701                 delete @$m{map { @$_ } @gone} and $self->{-culled_manifest} = 1;
 702                 delete @$m{grep(/$re/, @v1)} and $self->{-culled_manifest} = 1;
 703                 @v1 = grep(!/$re/, @v1);
 704         }
 705         my $ret; # { v1 => [ ... ], v2 => { "/$inbox_name" => [ epochs ] }}
 706         $ret->{v1} = \@v1 if @v1;
 707         $ret->{v2} = $v2 if keys %$v2;
 708         $ret //= @orig ? "Nothing to clone, available repositories:\n\t".
 709                                 join("\n\t", sort @orig)
 710                         : "Nothing available to clone\n";
 711         my $path_pfx = '';
 712
 713         # PSGI mount prefixes and manifest.js.gz prefixes don't always align...
 714         if (@v2_epochs) {
 715                 until (grep(m!\A\Q$$path\E/git/[0-9]+\.git\z!,
 716                                 @v2_epochs) == @v2_epochs) {
 717                         $$path =~ s!\A(/[^/]+)/!/! or last;
 718                         $path_pfx .= $1;
 719                 }
 720         } elsif (@v1) {
 721                 while (!defined($m->{$$path}) && $$path =~ s!\A(/[^/]+)/!/!) {
 722                         $path_pfx .= $1;
 723                 }
 724         }
 725         ($path_pfx, $n, $ret);
 726 }
 727
 728 sub clone_all {
 729         my ($self, $m) = @_;
 730         my $todo = delete $self->{todo};
 731         my $nodep = delete $todo->{''};
 732
 733         # do not download unwanted deps
 734         my $any_want = delete $self->{any_want};
 735         my @unwanted = grep { !$any_want->{$_} } keys %$todo;
 736         my @nodep = delete(@$todo{@unwanted});
 737         push(@$nodep, @$_) for @nodep;
 738
 739         # handle no-dependency repos, first
 740         for (@$nodep) {
 741                 clone_v1($_, 1);
 742                 return if $self->{lei}->{child_error};
 743         }
 744         # resolve references, deepest, first:
 745         while (scalar keys %$todo) {
 746                 for my $x (keys %$todo) {
 747                         my ($nr, $nxt);
 748                         # resolve multi-level references
 749                         while ($m && defined($nxt = $m->{$x}->{reference})) {
 750                                 exists($todo->{$nxt}) or last;
 751                                 die <<EOM if ++$nr > 1000;
 752 E: dependency loop detected (`$x' => `$nxt')
 753 EOM
 754                                 $x = $nxt;
 755                         }
 756                         my $y = delete $todo->{$x} // next; # already done
 757                         for (@$y) {
 758                                 clone_v1($_, 1);
 759                                 return if $self->{lei}->{child_error};
 760                         }
 761                         last; # restart %$todo iteration
 762                 }
 763         }
 764         do_reap($self, 1);
 765 }
 766
 767 sub dump_manifest ($$) {
 768         my ($m, $ft) = @_;
 769         # write the smaller manifest if epochs were skipped so
 770         # users won't have to delete manifest if they +w an
 771         # epoch they no longer want to skip
 772         my $json = PublicInbox::Config->json->encode($m);
 773         my $mtime = (stat($ft))[9];
 774         seek($ft, SEEK_SET, 0) or die "seek($ft): $!";
 775         truncate($ft, 0) or die "truncate($ft): $!";
 776         gzip(\$json => $ft) or die "gzip($ft): $GzipError";
 777         $ft->flush or die "flush($ft): $!";
 778         utime($mtime, $mtime, "$ft") or die "utime(..., $ft): $!";
 779 }
 780
 781 # FIXME: this gets confused by single inbox instance w/ global manifest.js.gz
 782 sub try_manifest {
 783         my ($self) = @_;
 784         my $uri = URI->new($self->{src});
 785         my $lei = $self->{lei};
 786         my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
 787         my $path = $uri->path;
 788         chop($path) eq '/' or die "BUG: $uri not canonicalized";
 789         $uri->path($path . '/manifest.js.gz');
 790         my $ft = File::Temp->new(TEMPLATE => '.manifest-XXXX',
 791                                 UNLINK => 1, TMPDIR => 1, SUFFIX => '.tmp');
 792         my $cmd = $curl->for_uri($lei, $uri, qw(-f -R -o), $ft->filename);
 793         my %opt = map { $_ => $lei->{$_} } (0..2);
 794         my $cerr = run_reap($lei, $cmd, \%opt);
 795         if ($cerr) {
 796                 return try_scrape($self) if ($cerr >> 8) == 22; # 404 missing
 797                 return $lei->child_error($cerr, "@$cmd failed");
 798         }
 799         my $m = eval { decode_manifest($ft, $ft, $uri) };
 800         if ($@) {
 801                 warn $@;
 802                 return try_scrape($self);
 803         }
 804         my ($path_pfx, $n, $multi) = multi_inbox($self, \$path, $m);
 805         return $lei->child_error(1, $multi) if !ref($multi);
 806         my $v2 = delete $multi->{v2};
 807         local $self->{todo} = {};
 808         if ($v2) {
 809                 for my $name (sort keys %$v2) {
 810                         my $epochs = delete $v2->{$name};
 811                         my %v2_epochs = map {
 812                                 $uri->path($n > 1 ? $path_pfx.$path.$_
 813                                                 : $path_pfx.$_);
 814                                 my ($e) = ("$uri" =~ m!/([0-9]+)\.git\z!);
 815                                 $e // die "no [0-9]+\.git in `$uri'";
 816                                 $e => [ $uri->clone, $_ ];
 817                         } @$epochs;
 818                         ("$uri" =~ m!\A(.+/)git/[0-9]+\.git\z!) or
 819                                 die "BUG: `$uri' !~ m!/git/[0-9]+.git!";
 820                         local $self->{cur_src} = $1;
 821                         local $self->{cur_dst} = $self->{dst};
 822                         if ($n > 1 && $uri->path =~ m!\A\Q$path_pfx$path\E/(.+)/
 823                                                         git/[0-9]+\.git\z!x) {
 824                                 $self->{cur_dst} .= "/$1";
 825                         }
 826                         index($self->{cur_dst}, "\n") >= 0 and die <<EOM;
 827 E: `$self->{cur_dst}' must not contain newline
 828 EOM
 829                         clone_v2_prep($self, \%v2_epochs, $m);
 830                         return if $self->{lei}->{child_error};
 831                 }
 832         }
 833         if (my $v1 = delete $multi->{v1}) {
 834                 my $p = $path_pfx.$path;
 835                 chop($p) if substr($p, -1, 1) eq '/';
 836                 $uri->path($p);
 837                 for my $name (@$v1) {
 838                         my $task = bless { %$self }, __PACKAGE__;
 839                         $task->{-ent} = $m->{$name} //
 840                                         die("BUG: no `$name' in manifest");
 841                         $task->{cur_src} = "$uri";
 842                         $task->{cur_dst} = $task->{dst};
 843                         $task->{-key} = $name;
 844                         if ($n > 1) {
 845                                 $task->{cur_dst} .= $name;
 846                                 $task->{cur_src} .= $name;
 847                         }
 848                         index($task->{cur_dst}, "\n") >= 0 and die <<EOM;
 849 E: `$task->{cur_dst}' must not contain newline
 850 EOM
 851                         $task->{cur_src} .= '/';
 852                         my $dep = $task->{-ent}->{reference} // '';
 853                         push @{$self->{todo}->{$dep}}, $task; # for clone_all
 854                         $self->{any_want}->{$name} = 1;
 855                 }
 856         }
 857         delete local $lei->{opt}->{epoch} if defined($v2);
 858         clone_all($self, $m);
 859         return if $self->{lei}->{child_error} || $self->{dry_run};
 860
 861         # set by clone_v2_prep/-I/--exclude
 862         dump_manifest($m => $ft) if delete $self->{-culled_manifest};
 863         ft_rename($ft, "$self->{dst}/manifest.js.gz", 0666);
 864         open my $x, '>', "$self->{dst}/mirror.done"; # for _wq_done_wait
 865 }
 866
 867 sub start_clone_url {
 868         my ($self) = @_;
 869         return try_manifest($self) if $self->{src} =~ m!\Ahttps?://!;
 870         die "TODO: non-HTTP/HTTPS clone of $self->{src} not supported, yet";
 871 }
 872
 873 sub do_mirror { # via wq_io_do or public-inbox-clone
 874         my ($self) = @_;
 875         my $lei = $self->{lei};
 876         umask($lei->{client_umask}) if defined $lei->{client_umask};
 877         eval {
 878                 my $ic = $lei->{opt}->{'inbox-config'} //= 'always';
 879                 $ic =~ /\A(?:v1|v2|always|never)\z/s or die <<"";
 880 --inbox-config must be one of `always', `v2', `v1', or `never'
 881
 882                 if (defined(my $os = $lei->{opt}->{objstore})) {
 883                         $os = 'objstore' if $os eq ''; # --objstore w/o args
 884                         $self->{-objstore} = "$self->{dst}/$os";
 885                 }
 886                 local $LIVE;
 887                 my $iv = $lei->{opt}->{'inbox-version'} //
 888                         return start_clone_url($self);
 889                 return clone_v1($self) if $iv == 1;
 890                 die "bad --inbox-version=$iv\n" if $iv != 2;
 891                 die <<EOM if $self->{src} !~ m!://!;
 892 cloning local v2 inboxes not supported
 893 EOM
 894                 try_scrape($self, 1);
 895         };
 896         $lei->fail($@) if $@;
 897 }
 898
 899 sub start {
 900         my ($cls, $lei, $src, $dst) = @_;
 901         my $self = bless { src => $src, dst => $dst }, $cls;
 902         $lei->request_umask;
 903         my ($op_c, $ops) = $lei->workers_start($self, 1);
 904         $lei->{wq1} = $self;
 905         $self->wq_io_do('do_mirror', []);
 906         $self->wq_close;
 907         $lei->wait_wq_events($op_c, $ops);
 908 }
 909
 910 sub ipc_atfork_child {
 911         my ($self) = @_;
 912         $self->{lei}->_lei_atfork_child;
 913         $self->SUPER::ipc_atfork_child;
 914 }
 915
 916 sub write_makefile {
 917         my ($dir, $ibx_ver) = @_;
 918         my $f = "$dir/Makefile";
 919         if (sysopen my $fh, $f, O_CREAT|O_EXCL|O_WRONLY) {
 920                 print $fh <<EOM or die "print($f) $!";
 921 # This is a v$ibx_ver public-inbox, see the public-inbox-v$ibx_ver-format(5)
 922 # manpage for more information on the format.  This Makefile is
 923 # intended as a familiar wrapper for users unfamiliar with
 924 # public-inbox-* commands.
 925 #
 926 # See the respective manpages for public-inbox-fetch(1),
 927 # public-inbox-index(1), etc for more information on
 928 # some of the commands used by this Makefile.
 929 #
 930 # This Makefile will not be modified nor read by public-inbox,
 931 # so you may edit it freely with your own convenience targets
 932 # and notes.  public-inbox-fetch will recreate it if removed.
 933 EOM
 934                 print $fh <<'EOM' or die "print($f): $!";
 935 # the default target:
 936 help :
 937         @echo Common targets:
 938         @echo '    make fetch        - fetch from remote git repostorie(s)'
 939         @echo '    make update       - fetch and update index '
 940         @echo
 941         @echo Rarely needed targets:
 942         @echo '    make reindex      - may be needed for new features/bugfixes'
 943         @echo '    make compact      - rewrite Xapian storage to save space'
 944         @echo '    make index        - initial index after clone
 945
 946 fetch :
 947         public-inbox-fetch
 948 update :
 949         @if ! public-inbox-fetch --exit-code; \
 950         then \
 951                 c=$$?; \
 952                 test $$c -eq 127 && exit 0; \
 953                 exit $$c; \
 954         elif test -f msgmap.sqlite3 || test -f public-inbox/msgmap.sqlite3; \
 955         then \
 956                 public-inbox-index; \
 957         else \
 958                 echo 'public-inbox index not initialized'; \
 959                 echo 'see public-inbox-index(1) man page'; \
 960         fi
 961 index :
 962         public-inbox-index
 963 reindex :
 964         public-inbox-index --reindex
 965 compact :
 966         public-inbox-compact
 967
 968 .PHONY : help fetch update index reindex compact
 969 EOM
 970                 close $fh or die "close($f): $!";
 971         } else {
 972                 die "open($f): $!" unless $!{EEXIST};
 973         }
 974 }
 975
 976 1;