1 # Copyright (C) all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # "lei add-external --mirror" support (also "public-inbox-clone");
5 package PublicInbox::LeiMirror;
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);
14 use Fcntl qw(SEEK_SET O_CREAT O_EXCL O_WRONLY);
17 use PublicInbox::Config;
18 use PublicInbox::Inbox;
19 use PublicInbox::LeiCurl;
20 use PublicInbox::OnDestroy;
21 use Digest::SHA qw(sha256_hex);
23 our $LIVE; # pid => callback
25 sub _wq_done_wait { # dwaitpid callback (via wq_eof)
27 my ($mrr, $lei) = @$arg;
28 my $f = "$mrr->{dst}/mirror.done";
30 $lei->child_error($?);
31 } elsif (!$mrr->{dry_run} && !unlink($f)) {
32 warn("unlink($f): $!\n") unless $!{ENOENT};
34 if (!$mrr->{dry_run} && $lei->{cmd} ne 'public-inbox-clone') {
35 require PublicInbox::LeiAddExternal;
36 PublicInbox::LeiAddExternal::_finish_add_external(
39 $lei->qerr("# mirrored $mrr->{src} => $mrr->{dst}");
44 # for old installations without manifest.js.gz
46 my ($self, $fallback_manifest) = @_;
47 my $uri = URI->new($self->{src});
48 my $lei = $self->{lei};
49 my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
50 my $cmd = $curl->for_uri($lei, $uri, qw(-f --compressed));
51 my $opt = { 0 => $lei->{0}, 2 => $lei->{2} };
52 my $fh = popen_rd($cmd, undef, $opt);
53 my $html = do { local $/; <$fh> } // die "read(curl $uri): $!";
54 close($fh) or return $lei->child_error($?, "@$cmd failed");
56 # we grep with URL below, we don't want Subject/From headers
57 # making us clone random URLs. This assumes remote instances
58 # prior to public-inbox 1.7.0
59 # 5b96edcb1e0d8252 (www: move mirror instructions to /text/, 2021-08-28)
60 my @html = split(/<hr>/, $html);
61 my @urls = ($html[-1] =~ m!\bgit clone --mirror ([a-z\+]+://\S+)!g);
62 if (!@urls && $fallback_manifest) {
64 W: failed to extract URLs from $uri, trying manifest.js.gz...
66 return start_clone_url($self);
68 my $url = $uri->as_string;
69 chop($url) eq '/' or die "BUG: $uri not canonicalized";
71 # since this is for old instances w/o manifest.js.gz, try v1 first
72 return clone_v1($self) if grep(m!\A\Q$url\E/*\z!, @urls);
73 if (my @v2_urls = grep(m!\A\Q$url\E/[0-9]+\z!, @urls)) {
75 my ($n) = (m!/([0-9]+)\z!);
76 $n => [ URI->new($_), '' ]
78 clone_v2_prep($self, \%v2_epochs);
79 delete local $lei->{opt}->{epoch};
84 # filter out common URLs served by WWW (e.g /$MSGID/T/)
85 if (@urls && $url =~ s!/+[^/]+\@[^/]+/.*\z!! &&
86 grep(m!\A\Q$url\E/*\z!, @urls)) {
88 E: confused by scraping <$uri>, did you mean <$url>?
92 E: confused by scraping <$uri>, got ambiguous results:
95 die "E: scraping <$uri> revealed nothing\n";
101 $opt->{$_} = $lei->{$_} for (0..2);
102 # we support "-c $key=$val" for arbitrary git config options
103 # e.g.: git -c http.proxy=socks5h://127.0.0.1:9050
104 push(@cmd, '-c', $_) for @{$lei->{opt}->{c} // []};
105 push @cmd, qw(clone --mirror);
106 push @cmd, '-q' if $lei->{opt}->{quiet} ||
107 ($lei->{opt}->{jobs} // 1) > 1;
108 push @cmd, '-v' if $lei->{opt}->{verbose};
109 # XXX any other options to support?
110 # --reference is tricky with multiple epochs, but handled
111 # automatically if using manifest.js.gz
115 sub ft_rename ($$$;$) {
116 my ($ft, $dst, $open_mode, $fh) = @_;
117 my @st = stat($fh // $dst);
118 my $mode = @st ? ($st[2] & 07777) : ($open_mode & ~umask);
119 chmod($mode, $ft) or croak "E: chmod($ft): $!";
121 File::Copy::mv($ft->filename, $dst) or croak "E: mv($ft => $dst): $!";
122 $ft->unlink_on_destroy(0);
126 my ($self, $jobs) = @_;
127 $jobs //= $self->{-jobs} //= $self->{lei}->{opt}->{jobs} // 1;
128 $jobs = 1 if $jobs < 1;
129 while (keys(%$LIVE) >= $jobs) {
130 my $pid = waitpid(-1, 0) // die "waitpid(-1): $!";
131 if (my $x = delete $LIVE->{$pid}) {
135 warn "reaped unknown PID=$pid ($?)\n";
140 sub _get_txt_start { # non-fatal
141 my ($self, $endpoint, $fini) = @_;
142 my $uri = URI->new($self->{cur_src} // $self->{src});
143 my $lei = $self->{lei};
144 my $path = $uri->path;
145 chop($path) eq '/' or die "BUG: $uri not canonicalized";
146 $uri->path("$path/$endpoint");
147 my $f = (split(m!/!, $endpoint))[-1];
148 my $ft = File::Temp->new(TEMPLATE => "$f-XXXX", TMPDIR => 1);
149 my $opt = { 0 => $lei->{0}, 1 => $lei->{1}, 2 => $lei->{2} };
150 my $cmd = $self->{curl}->for_uri($lei, $uri, qw(-f --compressed -R -o),
153 $lei->qerr("# @$cmd");
154 return if $self->{dry_run};
155 $self->{"-get_txt.$endpoint"} = [ $ft, $cmd, $uri ];
156 $LIVE->{spawn($cmd, undef, $opt)} =
157 [ \&_get_txt_done, $self, $endpoint, $fini ];
160 sub _get_txt_done { # returns true on error (non-fatal), undef on success
161 my ($self, $endpoint) = @_;
162 my ($fh, $cmd, $uri) = @{delete $self->{"-get_txt.$endpoint"}};
164 $? = 0; # don't influence normal lei exit
165 return warn("$uri missing\n") if ($cerr >> 8) == 22;
166 return warn("# @$cmd failed (non-fatal)\n") if $cerr;
167 seek($fh, SEEK_SET, 0) or die "seek: $!";
168 $self->{"mtime.$endpoint"} = (stat($fh))[9];
170 $self->{"txt.$endpoint"} = <$fh>;
174 sub _write_inbox_config {
176 my $buf = delete($self->{'txt._/text/config/raw'}) // return;
177 my $dst = $self->{cur_dst} // $self->{dst};
178 my $f = "$dst/inbox.config.example";
179 open my $fh, '>', $f or die "open($f): $!";
180 print $fh $buf or die "print: $!";
181 chmod(0444 & ~umask, $fh) or die "chmod($f): $!";
182 my $mtime = delete $self->{'mtime._/text/config/raw'};
183 $fh->flush or die "flush($f): $!";
184 if (defined $mtime) {
185 utime($mtime, $mtime, $fh) or die "utime($f): $!";
187 my $cfg = PublicInbox::Config->git_config_dump($f, $self->{lei}->{2});
188 my $ibx = $self->{ibx} = {};
189 for my $sec (grep(/\Apublicinbox\./, @{$cfg->{-section_order}})) {
190 for (qw(address newsgroup nntpmirror)) {
191 $ibx->{$_} = $cfg->{"$sec.$_"};
196 sub set_description ($) {
198 my $dst = $self->{cur_dst} // $self->{dst};
199 my $f = "$dst/description";
200 open my $fh, '+>>', $f or die "open($f): $!";
201 seek($fh, 0, SEEK_SET) or die "seek($f): $!";
202 my $d = do { local $/; <$fh> } // die "read($f): $!";
203 chomp(my $orig = $d);
204 while (defined($d) && ($d =~ m!^\(\$INBOX_DIR/description missing\)! ||
205 $d =~ /^Unnamed repository/ || $d !~ /\S/)) {
206 $d = delete($self->{'txt.description'});
208 $d //= 'mirror of '.($self->{cur_src} // $self->{src});
210 return if $d eq $orig;
211 seek($fh, 0, SEEK_SET) or die "seek($f): $!";
212 truncate($fh, 0) or die "truncate($f): $!";
213 print $fh $d, "\n" or die "print($f): $!";
214 close $fh or die "close($f): $!";
217 sub index_cloned_inbox {
218 my ($self, $iv) = @_;
219 my $lei = $self->{lei};
221 # n.b. public-inbox-clone works w/o (SQLite || Xapian)
222 # lei is useless without Xapian + SQLite
223 if ($lei->{cmd} ne 'public-inbox-clone') {
224 require PublicInbox::InboxWritable;
225 require PublicInbox::Admin;
226 my $ibx = delete($self->{ibx}) // {
227 address => [ 'lei@example.com' ],
230 $ibx->{inboxdir} = $self->{cur_dst} // $self->{dst};
231 PublicInbox::Inbox->new($ibx);
232 PublicInbox::InboxWritable->new($ibx);
234 for my $sw ($lei->index_opt) {
235 my ($k) = ($sw =~ /\A([\w-]+)/);
236 $opt->{$k} = $lei->{opt}->{$k};
238 # force synchronous dwaitpid for v2:
239 local $PublicInbox::DS::in_loop = 0;
240 my $cfg = PublicInbox::Config->new(undef, $lei->{2});
241 my $env = PublicInbox::Admin::index_prepare($opt, $cfg);
242 local %ENV = (%ENV, %$env) if $env;
243 PublicInbox::Admin::progress_prepare($opt, $lei->{2});
244 PublicInbox::Admin::index_inbox($ibx, undef, $opt);
246 return if defined $self->{cur_dst}; # one of many repos to clone
247 open my $x, '>', "$self->{dst}/mirror.done"; # for _wq_done_wait
251 my ($lei, $cmd, $opt) = @_;
252 $lei->qerr("# @$cmd");
253 waitpid(spawn($cmd, undef, $opt), 0) // die "waitpid: $!";
255 $? = 0; # don't let it influence normal exit
260 my ($self, $cmd, $opt, $fini) = @_;
262 $self->{lei}->qerr("# @$cmd");
263 return if $self->{dry_run};
264 $LIVE->{spawn($cmd, undef, $opt)} = [ \&reap_cmd, $self, $cmd, $fini ]
267 sub fetch_args ($$) {
268 my ($lei, $opt) = @_;
269 my @cmd; # (git --git-dir=...) to be added by caller
270 $opt->{$_} = $lei->{$_} for (0..2);
271 # we support "-c $key=$val" for arbitrary git config options
272 # e.g.: git -c http.proxy=socks5h://127.0.0.1:9050
273 push(@cmd, '-c', $_) for @{$lei->{opt}->{c} // []};
275 push @cmd, '-q' if $lei->{opt}->{quiet} ||
276 ($lei->{opt}->{jobs} // 1) > 1;
277 push @cmd, '-v' if $lei->{opt}->{verbose};
281 sub upr { # feed `git update-ref --stdin -z' verbosely
282 my ($lei, $w, $op, $ref, $oid) = @_;
283 $lei->qerr("# $op $ref $oid") if $lei->{opt}->{verbose};
284 print $w "$op $ref\0$oid\0" or die "print(w): $!";
289 my $srcfh = delete $fgrp->{srcfh} or return;
290 my $dstfh = delete $fgrp->{dstfh} or return;
291 seek($srcfh, SEEK_SET, 0) or die "seek(src): $!";
292 seek($dstfh, SEEK_SET, 0) or die "seek(dst): $!";
293 my %src = map { chomp; split(/\0/) } (<$srcfh>);
295 my %dst = map { chomp; split(/\0/) } (<$dstfh>);
297 pipe(my ($r, $w)) or die "pipe: $!";
298 my $cmd = [ 'git', "--git-dir=$fgrp->{cur_dst}",
299 qw(update-ref --stdin -z) ];
300 my $lei = $fgrp->{lei};
301 $lei->qerr("# @$cmd");
302 my $opt = { 0 => $r, 1 => $lei->{1}, 2 => $lei->{2} };
303 my $pid = spawn($cmd, undef, $opt);
304 close $r or die "close(r): $!";
305 for my $ref (keys %dst) {
306 my $new = delete $src{$ref};
307 my $old = $dst{$ref};
309 upr($lei, $w, 'update', $ref, $new) if $new ne $old;
311 upr($lei, $w, 'delete', $ref, $old);
314 while (my ($ref, $oid) = each %src) {
315 upr($lei, $w, 'create', $ref, $oid);
317 close($w) or warn "E: close(update-ref --stdin): $! (need git 1.8.5+)\n";
318 $LIVE->{$pid} = [ \&reap_cmd, $fgrp, $cmd ];
319 pack_refs($fgrp, $fgrp->{cur_dst});
323 my ($self, $git_dir) = @_;
325 my $cmd = [ 'git', "--git-dir=$git_dir", qw(pack-refs --all --prune) ];
326 $self->{lei}->qerr("# @$cmd");
327 return if $self->{dry_run};
328 my $opt = { 1 => $self->{lei}->{1}, 2 => $self->{lei}->{2} };
329 $LIVE->{spawn($cmd, undef, $opt)} = [ \&reap_cmd, $self, $cmd ];
336 my $first = $fgrpv->[0] // die 'BUG: no fgrpv->[0]';
337 pack_refs($first, $first->{-osdir}); # objstore refs always packed
338 for my $fgrp (@$fgrpv) {
339 my $rn = $fgrp->{-remote};
340 my %opt = map { $_ => $fgrp->{lei}->{$_} } (0..2);
342 my $update_ref = $fgrp->{dry_run} ? undef :
343 PublicInbox::OnDestroy->new($$, \&fgrp_update, $fgrp);
345 my $src = [ 'git', "--git-dir=$fgrp->{-osdir}", 'for-each-ref',
346 "--format=refs/%(refname:lstrip=3)%00%(objectname)",
347 "refs/remotes/$rn/" ];
349 $fgrp->{lei}->qerr("# @$src >SRC");
351 open(my $fh, '+>', undef) or die "open(src): $!";
352 $pid = spawn($src, undef, { %opt, 1 => $fh });
353 $fgrp->{srcfh} = $fh;
354 $LIVE->{$pid} = [ \&reap_cmd, $fgrp, $src, $update_ref ]
356 my $dst = [ 'git', "--git-dir=$fgrp->{cur_dst}", 'for-each-ref',
357 '--format=%(refname)%00%(objectname)' ];
359 $fgrp->{lei}->qerr("# @$dst >DST");
361 open(my $fh, '+>', undef) or die "open(dst): $!";
362 $pid = spawn($dst, undef, { %opt, 1 => $fh });
363 $fgrp->{dstfh} = $fh;
364 $LIVE->{$pid} = [ \&reap_cmd, $fgrp, $dst, $update_ref ]
371 my $todo = delete $self->{fgrp_todo} or return;
372 keys(%$todo) or return;
374 # Rely on the fgrptmp remote groups in the config file rather
375 # than listing all remotes since the remote name list may exceed
376 # system argv limits:
379 my @git = (@{$self->{-torsocks}}, 'git');
380 my $j = $self->{lei}->{opt}->{jobs};
383 local $self->{lei}->{opt}->{jobs} = 1;
384 (fetch_args($self->{lei}, $opt),
385 qw(--no-tags --multiple));
387 push(@fetch, "-j$j") if $j;
389 while (my ($osdir, $fgrpv) = each %$todo) {
390 my $f = "$osdir/config";
392 # clobber group from previous run atomically
393 my $cmd = ['git', "--git-dir=$osdir", qw(config -f),
394 $f, '--unset-all', "remotes.$grp"];
395 $self->{lei}->qerr("# @$cmd");
396 if (!$self->{dry_run}) {
398 waitpid($pid, 0) // die "waitpid: $!";
399 die "E: @$cmd: \$?=$?" if ($? && ($? >> 8) != 5);
401 # update the config atomically via O_APPEND while
402 # respecting git-config locking
403 sysopen(my $lk, "$f.lock", O_CREAT|O_EXCL|O_WRONLY)
404 or die "open($f.lock): $!";
405 open my $fh, '>>', $f or die "open(>>$f): $!";
407 my $buf = join('', "[remotes]\n",
408 map { "\t$grp = $_->{-remote}\n" } @$fgrpv);
409 print $fh $buf or die "print($f): $!";
410 close $fh or die "close($f): $!";
411 unlink("$f.lock") or die "unlink($f.lock): $!";
414 $cmd = [ @git, "--git-dir=$osdir", @fetch, $grp ];
416 $self->{lei}->qerr("# @$cmd");
417 my $end = PublicInbox::OnDestroy->new($$, \&fgrpv_done, $fgrpv);
418 return if $self->{dry_run};
419 $pid = spawn($cmd, undef, $opt);
420 $LIVE->{$pid} = [ \&reap_cmd, $self, $cmd, $end ];
424 # keep this idempotent for future use by public-inbox-fetch
426 my ($self, $uri) = @_;
427 $self->{-ent} // return;
428 my $os = $self->{-objstore} // return;
429 my $fg = $self->{-ent}->{forkgroup} // return;
430 my $dir = "$os/$fg.git";
431 my @cmd = ('git', "--git-dir=$dir", 'config');
432 my $opt = +{ map { $_ => $self->{lei}->{$_} } (0..2) };
433 if (!-d $dir && !$self->{dry_run}) {
434 PublicInbox::Import::init_bare($dir);
435 for ('repack.useDeltaIslands=true',
436 'pack.island=refs/remotes/([^/]+)/') {
437 run_die([@cmd, split(/=/, $_, 2)], undef, $opt);
440 my $key = $self->{-key} // die 'BUG: no -key';
441 my $rn = substr(sha256_hex($key), 0, 16);
442 unless ($self->{dry_run}) {
443 # --no-tags is required to avoid conflicts
444 for ("url=$uri", "fetch=+refs/*:refs/remotes/$rn/*",
445 'tagopt=--no-tags') {
446 my @kv = split(/=/, $_, 2);
447 $kv[0] = "remote.$rn.$kv[0]";
448 run_die([@cmd, @kv], undef, $opt);
451 if (!-d $self->{cur_dst} && !$self->{dry_run}) {
452 my $alt = File::Spec->rel2abs("$dir/objects");
453 PublicInbox::Import::init_bare($self->{cur_dst});
454 my $o = "$self->{cur_dst}/objects";
455 my $f = "$o/info/alternates";
456 my $l = File::Spec->abs2rel($alt, File::Spec->rel2abs($o));
457 open my $fh, '+>>', $f or die "open($f): $!";
458 seek($fh, SEEK_SET, 0) or die "seek($f): $!";
459 chomp(my @cur = <$fh>);
460 if (!grep(/\A\Q$l\E\z/, @cur)) {
461 say $fh $l or die "say($f): $!";
463 close $fh or die "close($f): $!";
464 $f = "$self->{cur_dst}/config";
465 open $fh, '+>>', $f or die "open:($f): $!";
466 print $fh <<EOM or die "print($f): $!";
467 ; rely on the "$rn" remote in the
468 ; $fg fork group for fetches
469 ; only uncomment the following iff you detach from fork groups
472 ; fetch = +refs/*:refs/*
475 close $fh or die "close($f): $!";
477 bless { %$self, -osdir => $dir, -remote => $rn }, __PACKAGE__;
481 my ($self, $nohang) = @_;
482 my $lei = $self->{lei};
483 my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
484 my $uri = URI->new($self->{cur_src} // $self->{src});
485 defined($lei->{opt}->{epoch}) and
486 die "$uri is a v1 inbox, --epoch is not supported\n";
487 $self->{-torsocks} //= $curl->torsocks($lei, $uri) or return;
488 my $dst = $self->{cur_dst} // $self->{dst};
489 my $fini = PublicInbox::OnDestroy->new($$, \&v1_done, $self);
490 if (my $fgrp = forkgroup_prep($self, $uri)) {
491 $fgrp->{-fini} = $fini;
492 push @{$self->{fgrp_todo}->{$fgrp->{-osdir}}}, $fgrp;
493 } else { # normal fetch
494 my $cmd = [ @{$self->{-torsocks}},
495 clone_cmd($lei, my $opt = {}), "$uri", $dst ];
496 if (defined($self->{-ent})) {
497 if (defined(my $ref = $self->{-ent}->{reference})) {
498 -e "$self->{dst}$ref" and
499 push @$cmd, '--reference',
503 start_clone($self, $cmd, $opt, $fini);
505 if (!$self->{-is_epoch} && $lei->{opt}->{'inbox-config'} =~
506 /\A(?:always|v1)\z/s) {
507 _get_txt_start($self, '_/text/config/raw', $fini);
510 my $d = $self->{-ent} ? $self->{-ent}->{description} : undef;
511 $self->{'txt.description'} = $d if defined $d;
512 (!defined($d) && !$nohang) and
513 _get_txt_start($self, 'description', $fini);
515 $nohang or do_reap($self, 1); # for non-manifest clone
518 sub parse_epochs ($$) {
519 my ($opt_epochs, $v2_epochs) = @_; # $epochs "LOW..HIGH"
520 $opt_epochs // return; # undef => all epochs
521 my ($lo, $dotdot, $hi, @extra) = split(/(\.\.)/, $opt_epochs);
522 undef($lo) if ($lo // '') eq '';
523 my $re = qr/\A~?[0-9]+\z/;
524 if (@extra || (($lo // '0') !~ $re) ||
525 (($hi // '0') !~ $re) ||
526 !(grep(defined, $lo, $hi))) {
528 --epoch=$opt_epochs not in the form of `LOW..HIGH', `LOW..', nor `..HIGH'
531 my @n = sort { $a <=> $b } keys %$v2_epochs;
532 for (grep(defined, $lo, $hi)) {
535 "`$_' exceeds maximum available epoch ($n[-1])\n";
537 "`$_' is lower than minimum available epoch ($n[0])\n";
538 } elsif (/\A~([0-9]+)/) {
540 $n[$off] // die "`$_' is out of range\n";
542 } else { die "`$_' not understood\n" }
544 defined($lo) && defined($hi) && $lo > $hi and die
545 "low value (`$lo') exceeds high (`$hi')\n";
546 $lo //= $n[0] if $dotdot;
547 $hi //= $n[-1] if $dotdot;
551 if (defined $v2_epochs->{$_}) {
555 "# epoch $_ is not available (non-fatal, $lo..$hi)\n";
561 sub init_placeholder ($$$) {
562 my ($src, $edst, $ent) = @_;
563 PublicInbox::Import::init_bare($edst);
564 my $f = "$edst/config";
565 open my $fh, '>>', $f or die "open($f): $!";
566 print $fh <<EOM or die "print($f): $!";
569 fetch = +refs/*:refs/*
572 ; This git epoch was created read-only and "public-inbox-fetch"
573 ; will not fetch updates for it unless write permission is added.
574 ; Hint: chmod +w $edst
576 if (defined($ent->{owner})) {
577 print $fh <<EOM or die "print($f): $!";
579 owner = $ent->{owner}
582 close $fh or die "close($f): $!";
583 my %map = (head => 'HEAD', description => undef);
584 while (my ($key, $fn) = each %map) {
585 my $val = $ent->{$key} // next;
588 open $fh, '>', $fn or die "open($fn): $!";
589 print $fh $val, "\n" or die "print($fn): $!";
590 close $fh or die "close($fn): $!";
594 sub reap_cmd { # async, called via SIGCHLD
595 my ($self, $cmd) = @_;
597 $? = 0; # don't let it influence normal exit
599 kill('TERM', keys %$LIVE);
600 $self->{lei}->child_error($cerr, "@$cmd failed");
604 sub v1_done { # called via OnDestroy
606 return if $self->{dry_run} || !$LIVE;
607 _write_inbox_config($self);
608 my $dst = $self->{cur_dst} // $self->{dst};
609 if (defined(my $o = $self->{-ent} ? $self->{-ent}->{owner} : undef)) {
610 run_die([qw(git config -f), "$dst/config", 'gitweb.owner', $o]);
612 my $o = "$dst/objects";
613 if (open(my $fh, '<', my $fn = "$o/info/alternates")) {;
614 my $base = File::Spec->rel2abs($o);
619 $_ = File::Spec->abs2rel($_, $base);
620 $ft //= File::Temp->new(TEMPLATE => '.XXXX',
624 print $ft @l or die "print($ft): $!";
625 $ft->flush or die "flush($ft): $!";
626 ft_rename($ft, $fn, 0666, $fh);
629 eval { set_description($self) };
631 return if ($self->{-is_epoch} ||
632 $self->{lei}->{opt}->{'inbox-config'} ne 'always');
633 write_makefile($dst, 1);
634 index_cloned_inbox($self, 1);
637 sub v2_done { # called via OnDestroy
639 return if $self->{dry_run} || !$LIVE;
640 my $dst = $self->{cur_dst} // $self->{dst};
641 require PublicInbox::Lock;
642 my $lk = bless { lock_path => "$dst/inbox.lock" }, 'PublicInbox::Lock';
643 my $lck = $lk->lock_for_scope($$);
644 _write_inbox_config($self);
645 require PublicInbox::MultiGit;
646 my $mg = PublicInbox::MultiGit->new($dst, 'all.git', 'git');
647 $mg->fill_alternates;
648 for my $i ($mg->git_epochs) { $mg->epoch_cfg_set($i) }
649 for my $edst (@{delete($self->{-read_only}) // []}) {
650 my @st = stat($edst) or die "stat($edst): $!";
651 chmod($st[2] & 0555, $edst) or die "chmod(a-w, $edst): $!";
653 write_makefile($dst, 2);
655 eval { set_description($self) };
657 index_cloned_inbox($self, 2);
660 sub clone_v2_prep ($$;$) {
661 my ($self, $v2_epochs, $m) = @_; # $m => manifest.js.gz hashref
662 my $lei = $self->{lei};
663 my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
664 my $first_uri = (map { $_->[0] } values %$v2_epochs)[0];
665 $self->{-torsocks} //= $curl->torsocks($lei, $first_uri) or return;
666 my $dst = $self->{cur_dst} // $self->{dst};
667 my $want = parse_epochs($lei->{opt}->{epoch}, $v2_epochs);
668 my $task = $m ? bless { %$self }, __PACKAGE__ : $self;
669 delete $task->{todo}; # $self->{todo} still exists
671 my $fini = PublicInbox::OnDestroy->new($$, \&v2_done, $task);
672 for my $nr (sort { $a <=> $b } keys %$v2_epochs) {
673 my ($uri, $key) = @{$v2_epochs->{$nr}};
674 my $src = $uri->as_string;
676 $src =~ m!/([0-9]+)(?:\.git)?\z! or die <<"";
677 failed to extract epoch number from $src
679 $1 + 0 == $nr or die "BUG: <$uri> miskeyed $1 != $nr";
680 $edst .= "/git/$nr.git";
684 die("BUG: `$key' not in manifest.js.gz");
685 if (defined(my $d = $ent->{description})) {
686 $d =~ s/ \[epoch [0-9]+\]\z//s;
690 if (!$want || $want->{$nr}) {
691 my $etask = bless { %$task, -key => $key }, __PACKAGE__;
692 $etask->{-ent} = $ent; # may have {reference}
693 $etask->{cur_src} = $src;
694 $etask->{cur_dst} = $edst;
695 $etask->{-is_epoch} = $fini;
696 my $ref = $ent->{reference} // '';
697 push @{$self->{todo}->{$ref}}, $etask;
698 $self->{any_want}->{$key} = 1;
699 } else { # create a placeholder so users only need to chmod +w
700 init_placeholder($src, $edst, $ent);
701 push @{$task->{-read_only}}, $edst;
705 # filter out the epochs we skipped
706 $self->{-culled_manifest} = 1 if $m && delete(@$m{@skip});
708 (!$self->{dry_run} && !-d $dst) and File::Path::mkpath($dst);
710 $lei->{opt}->{'inbox-config'} =~ /\A(?:always|v2)\z/s and
711 _get_txt_start($task, '_/text/config/raw', $fini);
713 defined($desc) ? ($task->{'txt.description'} = $desc) :
714 _get_txt_start($task, 'description', $fini);
717 sub decode_manifest ($$$) {
718 my ($fh, $fn, $uri) = @_;
720 my $gz = do { local $/; <$fh> } // die "slurp($fn): $!";
721 gunzip(\$gz => \$js, MultiStream => 1) or
722 die "gunzip($uri): $GunzipError\n";
723 my $m = eval { PublicInbox::Config->json->decode($js) };
724 die "$uri: error decoding `$js': $@\n" if $@;
725 ref($m) eq 'HASH' or die "$uri unknown type: ".ref($m);
729 sub multi_inbox ($$$) {
730 my ($self, $path, $m) = @_;
731 my $incl = $self->{lei}->{opt}->{include};
732 my $excl = $self->{lei}->{opt}->{exclude};
734 # assuming everything not v2 is v1, for now
735 my @v1 = sort grep(!m!.+/git/[0-9]+\.git\z!, keys %$m);
736 my @v2_epochs = sort grep(m!.+/git/[0-9]+\.git\z!, keys %$m);
740 m!\A(/.+)/git/[0-9]+\.git\z! or die "BUG: $_";
741 push @{$v2->{$1}}, $_;
743 my $n = scalar(keys %$v2) + scalar(@v1);
744 my @orig = defined($incl // $excl) ? (keys %$v2, @v1) : ();
746 my $re = '(?:'.join('\\z|', map {
747 $self->{lei}->glob2re($_) // qr/\A\Q$_\E/
749 my @gone = delete @$v2{grep(!/$re/, keys %$v2)};
750 delete @$m{map { @$_ } @gone} and $self->{-culled_manifest} = 1;
751 delete @$m{grep(!/$re/, @v1)} and $self->{-culled_manifest} = 1;
752 @v1 = grep(/$re/, @v1);
755 my $re = '(?:'.join('\\z|', map {
756 $self->{lei}->glob2re($_) // qr/\A\Q$_\E/
758 my @gone = delete @$v2{grep(/$re/, keys %$v2)};
759 delete @$m{map { @$_ } @gone} and $self->{-culled_manifest} = 1;
760 delete @$m{grep(/$re/, @v1)} and $self->{-culled_manifest} = 1;
761 @v1 = grep(!/$re/, @v1);
763 my $ret; # { v1 => [ ... ], v2 => { "/$inbox_name" => [ epochs ] }}
764 $ret->{v1} = \@v1 if @v1;
765 $ret->{v2} = $v2 if keys %$v2;
766 $ret //= @orig ? "Nothing to clone, available repositories:\n\t".
767 join("\n\t", sort @orig)
768 : "Nothing available to clone\n";
771 # PSGI mount prefixes and manifest.js.gz prefixes don't always align...
773 until (grep(m!\A\Q$$path\E/git/[0-9]+\.git\z!,
774 @v2_epochs) == @v2_epochs) {
775 $$path =~ s!\A(/[^/]+)/!/! or last;
779 while (!defined($m->{$$path}) && $$path =~ s!\A(/[^/]+)/!/!) {
783 ($path_pfx, $n, $ret);
788 my $todo = delete $self->{todo};
789 my $nodep = delete $todo->{''};
791 # do not download unwanted deps
792 my $any_want = delete $self->{any_want};
793 my @unwanted = grep { !$any_want->{$_} } keys %$todo;
794 my @nodep = delete(@$todo{@unwanted});
795 push(@$nodep, @$_) for @nodep;
797 # handle no-dependency repos, first
800 return if $self->{lei}->{child_error};
802 # resolve references, deepest, first:
803 while (scalar keys %$todo) {
804 for my $x (keys %$todo) {
806 # resolve multi-level references
807 while ($m && defined($nxt = $m->{$x}->{reference})) {
808 exists($todo->{$nxt}) or last;
809 die <<EOM if ++$nr > 1000;
810 E: dependency loop detected (`$x' => `$nxt')
814 my $y = delete $todo->{$x} // next; # already done
817 return if $self->{lei}->{child_error};
819 last; # restart %$todo iteration
822 fgrp_fetch_all($self);
826 sub dump_manifest ($$) {
828 # write the smaller manifest if epochs were skipped so
829 # users won't have to delete manifest if they +w an
830 # epoch they no longer want to skip
831 my $json = PublicInbox::Config->json->encode($m);
832 my $mtime = (stat($ft))[9];
833 seek($ft, SEEK_SET, 0) or die "seek($ft): $!";
834 truncate($ft, 0) or die "truncate($ft): $!";
835 gzip(\$json => $ft) or die "gzip($ft): $GzipError";
836 $ft->flush or die "flush($ft): $!";
837 utime($mtime, $mtime, "$ft") or die "utime(..., $ft): $!";
840 # FIXME: this gets confused by single inbox instance w/ global manifest.js.gz
843 my $uri = URI->new($self->{src});
844 my $lei = $self->{lei};
845 my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
846 $self->{-torsocks} //= $curl->torsocks($lei, $uri) or return;
847 my $path = $uri->path;
848 chop($path) eq '/' or die "BUG: $uri not canonicalized";
849 $uri->path($path . '/manifest.js.gz');
850 my $ft = File::Temp->new(TEMPLATE => '.manifest-XXXX',
851 UNLINK => 1, TMPDIR => 1, SUFFIX => '.tmp');
852 my $cmd = $curl->for_uri($lei, $uri, qw(-f -R -o), $ft->filename);
853 my %opt = map { $_ => $lei->{$_} } (0..2);
854 my $cerr = run_reap($lei, $cmd, \%opt);
856 return try_scrape($self) if ($cerr >> 8) == 22; # 404 missing
857 return $lei->child_error($cerr, "@$cmd failed");
859 my $m = eval { decode_manifest($ft, $ft, $uri) };
862 return try_scrape($self);
864 my ($path_pfx, $n, $multi) = multi_inbox($self, \$path, $m);
865 return $lei->child_error(1, $multi) if !ref($multi);
866 my $v2 = delete $multi->{v2};
867 local $self->{todo} = {};
868 local $self->{fgrp_todo} = {}; # { objstore_dir => [fgrp, ...] }
870 for my $name (sort keys %$v2) {
871 my $epochs = delete $v2->{$name};
872 my %v2_epochs = map {
873 $uri->path($n > 1 ? $path_pfx.$path.$_
875 my ($e) = ("$uri" =~ m!/([0-9]+)\.git\z!);
876 $e // die "no [0-9]+\.git in `$uri'";
877 $e => [ $uri->clone, $_ ];
879 ("$uri" =~ m!\A(.+/)git/[0-9]+\.git\z!) or
880 die "BUG: `$uri' !~ m!/git/[0-9]+.git!";
881 local $self->{cur_src} = $1;
882 local $self->{cur_dst} = $self->{dst};
883 if ($n > 1 && $uri->path =~ m!\A\Q$path_pfx$path\E/(.+)/
884 git/[0-9]+\.git\z!x) {
885 $self->{cur_dst} .= "/$1";
887 index($self->{cur_dst}, "\n") >= 0 and die <<EOM;
888 E: `$self->{cur_dst}' must not contain newline
890 clone_v2_prep($self, \%v2_epochs, $m);
891 return if $self->{lei}->{child_error};
894 if (my $v1 = delete $multi->{v1}) {
895 my $p = $path_pfx.$path;
896 chop($p) if substr($p, -1, 1) eq '/';
898 for my $name (@$v1) {
899 my $task = bless { %$self }, __PACKAGE__;
900 $task->{-ent} = $m->{$name} //
901 die("BUG: no `$name' in manifest");
902 $task->{cur_src} = "$uri";
903 $task->{cur_dst} = $task->{dst};
904 $task->{-key} = $name;
906 $task->{cur_dst} .= $name;
907 $task->{cur_src} .= $name;
909 index($task->{cur_dst}, "\n") >= 0 and die <<EOM;
910 E: `$task->{cur_dst}' must not contain newline
912 $task->{cur_src} .= '/';
913 my $dep = $task->{-ent}->{reference} // '';
914 push @{$self->{todo}->{$dep}}, $task; # for clone_all
915 $self->{any_want}->{$name} = 1;
918 delete local $lei->{opt}->{epoch} if defined($v2);
919 clone_all($self, $m);
920 return if $self->{lei}->{child_error} || $self->{dry_run};
922 # set by clone_v2_prep/-I/--exclude
923 dump_manifest($m => $ft) if delete $self->{-culled_manifest};
924 ft_rename($ft, "$self->{dst}/manifest.js.gz", 0666);
925 open my $x, '>', "$self->{dst}/mirror.done"; # for _wq_done_wait
928 sub start_clone_url {
930 return try_manifest($self) if $self->{src} =~ m!\Ahttps?://!;
931 die "TODO: non-HTTP/HTTPS clone of $self->{src} not supported, yet";
934 sub do_mirror { # via wq_io_do or public-inbox-clone
936 my $lei = $self->{lei};
937 $self->{dry_run} = 1 if $lei->{opt}->{'dry-run'};
938 umask($lei->{client_umask}) if defined $lei->{client_umask};
940 my $ic = $lei->{opt}->{'inbox-config'} //= 'always';
941 $ic =~ /\A(?:v1|v2|always|never)\z/s or die <<"";
942 --inbox-config must be one of `always', `v2', `v1', or `never'
944 if (defined(my $os = $lei->{opt}->{objstore})) {
945 $os = 'objstore' if $os eq ''; # --objstore w/o args
946 $os = "$self->{dst}/$os" if $os !~ m!\A/!;
947 $self->{-objstore} = $os;
950 my $iv = $lei->{opt}->{'inbox-version'} //
951 return start_clone_url($self);
952 return clone_v1($self) if $iv == 1;
953 die "bad --inbox-version=$iv\n" if $iv != 2;
954 die <<EOM if $self->{src} !~ m!://!;
955 cloning local v2 inboxes not supported
957 try_scrape($self, 1);
959 $lei->fail($@) if $@;
963 my ($cls, $lei, $src, $dst) = @_;
964 my $self = bless { src => $src, dst => $dst }, $cls;
966 my ($op_c, $ops) = $lei->workers_start($self, 1);
968 $self->wq_io_do('do_mirror', []);
970 $lei->wait_wq_events($op_c, $ops);
973 sub ipc_atfork_child {
975 $self->{lei}->_lei_atfork_child;
976 $self->SUPER::ipc_atfork_child;
980 my ($dir, $ibx_ver) = @_;
981 my $f = "$dir/Makefile";
982 if (sysopen my $fh, $f, O_CREAT|O_EXCL|O_WRONLY) {
983 print $fh <<EOM or die "print($f) $!";
984 # This is a v$ibx_ver public-inbox, see the public-inbox-v$ibx_ver-format(5)
985 # manpage for more information on the format. This Makefile is
986 # intended as a familiar wrapper for users unfamiliar with
987 # public-inbox-* commands.
989 # See the respective manpages for public-inbox-fetch(1),
990 # public-inbox-index(1), etc for more information on
991 # some of the commands used by this Makefile.
993 # This Makefile will not be modified nor read by public-inbox,
994 # so you may edit it freely with your own convenience targets
995 # and notes. public-inbox-fetch will recreate it if removed.
997 print $fh <<'EOM' or die "print($f): $!";
998 # the default target:
1000 @echo Common targets:
1001 @echo ' make fetch - fetch from remote git repostorie(s)'
1002 @echo ' make update - fetch and update index '
1004 @echo Rarely needed targets:
1005 @echo ' make reindex - may be needed for new features/bugfixes'
1006 @echo ' make compact - rewrite Xapian storage to save space'
1007 @echo ' make index - initial index after clone
1012 @if ! public-inbox-fetch --exit-code; \
1015 test $$c -eq 127 && exit 0; \
1017 elif test -f msgmap.sqlite3 || test -f public-inbox/msgmap.sqlite3; \
1019 public-inbox-index; \
1021 echo 'public-inbox index not initialized'; \
1022 echo 'see public-inbox-index(1) man page'; \
1027 public-inbox-index --reindex
1029 public-inbox-compact
1031 .PHONY : help fetch update index reindex compact
1033 close $fh or die "close($f): $!";
1035 die "open($f): $!" unless $!{EEXIST};