-# Copyright (C) 2021 all contributors <meta@public-inbox.org>
+# Copyright (C) all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
-# "lei add-external --mirror" support
+# "lei add-external --mirror" support (also "public-inbox-clone");
package PublicInbox::LeiMirror;
-use strict;
-use v5.10.1;
+use v5.12;
use parent qw(PublicInbox::IPC);
use IO::Uncompress::Gunzip qw(gunzip $GunzipError);
-use PublicInbox::Spawn qw(popen_rd spawn);
+use IO::Compress::Gzip qw(gzip $GzipError);
+use PublicInbox::Spawn qw(popen_rd spawn run_die);
+use File::Path ();
+use File::Temp ();
+use File::Spec ();
+use Fcntl qw(SEEK_SET O_CREAT O_EXCL O_WRONLY);
+use Carp qw(croak);
+use URI;
+use PublicInbox::Config;
+use PublicInbox::Inbox;
+use PublicInbox::LeiCurl;
+use PublicInbox::OnDestroy;
+use Digest::SHA qw(sha256_hex);
-sub do_finish_mirror { # dwaitpid callback
+our $LIVE; # pid => callback
+my $update_ref_stdin = $ENV{GIT_CAN_UPDATE_REF_STDIN} // 1;
+
+sub _wq_done_wait { # dwaitpid callback (via wq_eof)
my ($arg, $pid) = @_;
my ($mrr, $lei) = @$arg;
my $f = "$mrr->{dst}/mirror.done";
if ($?) {
$lei->child_error($?);
- } elsif (!unlink($f)) {
- $lei->err("unlink($f): $!");
+ } elsif (!$mrr->{dry_run} && !unlink($f)) {
+ warn("unlink($f): $!\n") unless $!{ENOENT};
} else {
- $lei->add_external_finish($mrr->{dst});
+ if (!$mrr->{dry_run} && $lei->{cmd} ne 'public-inbox-clone') {
+ require PublicInbox::LeiAddExternal;
+ PublicInbox::LeiAddExternal::_finish_add_external(
+ $lei, $mrr->{dst});
+ }
$lei->qerr("# mirrored $mrr->{src} => $mrr->{dst}");
}
$lei->dclose;
}
-sub _lei_wq_eof { # EOF callback for main daemon
- my ($lei) = @_;
- my $mrr = delete $lei->{wq1} or return $lei->fail;
- $mrr->wq_wait_old(\&do_finish_mirror, $lei);
-}
-
# for old installations without manifest.js.gz
sub try_scrape {
- my ($self) = @_;
+ my ($self, $fallback_manifest) = @_;
my $uri = URI->new($self->{src});
my $lei = $self->{lei};
my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
- my $cmd = $curl->for_uri($lei, $uri, '--compressed');
+ my $cmd = $curl->for_uri($lei, $uri, qw(-f --compressed));
my $opt = { 0 => $lei->{0}, 2 => $lei->{2} };
my $fh = popen_rd($cmd, undef, $opt);
my $html = do { local $/; <$fh> } // die "read(curl $uri): $!";
close($fh) or return $lei->child_error($?, "@$cmd failed");
# we grep with URL below, we don't want Subject/From headers
- # making us clone random URLs
- my @urls = ($html =~ m!\bgit clone --mirror ([a-z\+]+://\S+)!g);
+ # making us clone random URLs. This assumes remote instances
+ # prior to public-inbox 1.7.0
+ # 5b96edcb1e0d8252 (www: move mirror instructions to /text/, 2021-08-28)
+ my @html = split(/<hr>/, $html);
+ my @urls = ($html[-1] =~ m!\bgit clone --mirror ([a-z\+]+://\S+)!g);
+ if (!@urls && $fallback_manifest) {
+ warn <<EOM;
+W: failed to extract URLs from $uri, trying manifest.js.gz...
+EOM
+ return start_clone_url($self);
+ }
my $url = $uri->as_string;
chop($url) eq '/' or die "BUG: $uri not canonicalized";
# since this is for old instances w/o manifest.js.gz, try v1 first
return clone_v1($self) if grep(m!\A\Q$url\E/*\z!, @urls);
if (my @v2_urls = grep(m!\A\Q$url\E/[0-9]+\z!, @urls)) {
- my %v2_uris = map { $_ => URI->new($_) } @v2_urls; # uniq
- return clone_v2($self, [ values %v2_uris ]);
+ my %v2_epochs = map {
+ my ($n) = (m!/([0-9]+)\z!);
+ $n => [ URI->new($_), '' ]
+ } @v2_urls; # uniq
+ clone_v2_prep($self, \%v2_epochs);
+ delete local $lei->{opt}->{epoch};
+ clone_all($self);
+ return;
}
# filter out common URLs served by WWW (e.g /$MSGID/T/)
# e.g.: git -c http.proxy=socks5h://127.0.0.1:9050
push(@cmd, '-c', $_) for @{$lei->{opt}->{c} // []};
push @cmd, qw(clone --mirror);
- push @cmd, '-q' if $lei->{opt}->{quiet};
+ push @cmd, '-q' if $lei->{opt}->{quiet} ||
+ ($lei->{opt}->{jobs} // 1) > 1;
push @cmd, '-v' if $lei->{opt}->{verbose};
# XXX any other options to support?
- # --reference is tricky with multiple epochs...
+ # --reference is tricky with multiple epochs, but handled
+ # automatically if using manifest.js.gz
@cmd;
}
-# tries the relatively new /$INBOX/_/text/config/raw endpoint
-sub _try_config {
- my ($self) = @_;
- my $dst = $self->{dst};
- if (!-d $dst || !mkdir($dst)) {
- require File::Path;
- File::Path::mkpath($dst);
- -d $dst or die "mkpath($dst): $!\n";
+sub ft_rename ($$$) {
+ my ($ft, $dst, $open_mode) = @_;
+ my @st = stat($dst);
+ my $mode = @st ? ($st[2] & 07777) : ($open_mode & ~umask);
+ chmod($mode, $ft) or croak "E: chmod($ft): $!";
+ require File::Copy;
+ File::Copy::mv($ft->filename, $dst) or croak "E: mv($ft => $dst): $!";
+ $ft->unlink_on_destroy(0);
+}
+
+sub do_reap ($;$) {
+ my ($self, $jobs) = @_;
+ $jobs //= $self->{-jobs} //= $self->{lei}->{opt}->{jobs} // 1;
+ $jobs = 1 if $jobs < 1;
+ while (keys(%$LIVE) >= $jobs) {
+ my $pid = waitpid(-1, 0) // die "waitpid(-1): $!";
+ if (my $x = delete $LIVE->{$pid}) {
+ my $cb = shift @$x;
+ $cb->(@$x) if $cb;
+ } else {
+ warn "reaped unknown PID=$pid ($?)\n";
+ }
}
- my $uri = URI->new($self->{src});
+}
+
+sub _get_txt_start { # non-fatal
+ my ($self, $endpoint, $fini) = @_;
+ my $uri = URI->new($self->{cur_src} // $self->{src});
my $lei = $self->{lei};
my $path = $uri->path;
chop($path) eq '/' or die "BUG: $uri not canonicalized";
- $uri->path($path . '/_/text/config/raw');
- my $cmd = $self->{curl}->for_uri($lei, $uri, '--compressed');
- my $ce = "$dst/inbox.config.example";
- my $f = "$ce-$$.tmp";
- open(my $fh, '+>', $f) or return $lei->err("open $f: $! (non-fatal)");
- my $opt = { 0 => $lei->{0}, 1 => $fh, 2 => $lei->{2} };
- my $cerr = run_reap($lei, $cmd, $opt) // return;
- if (($cerr >> 8) == 22) { # 404 missing
- unlink($f) if -s $fh == 0;
- return;
+ $uri->path("$path/$endpoint");
+ my $f = (split(m!/!, $endpoint))[-1];
+ my $ft = File::Temp->new(TEMPLATE => "$f-XXXX", TMPDIR => 1);
+ my $opt = { 0 => $lei->{0}, 1 => $lei->{1}, 2 => $lei->{2} };
+ my $cmd = $self->{curl}->for_uri($lei, $uri, qw(-f --compressed -R -o),
+ $ft->filename);
+ do_reap($self);
+ $lei->qerr("# @$cmd");
+ return if $self->{dry_run};
+ $self->{"-get_txt.$endpoint"} = [ $ft, $cmd, $uri ];
+ $LIVE->{spawn($cmd, undef, $opt)} =
+ [ \&_get_txt_done, $self, $endpoint, $fini ];
+}
+
+sub _get_txt_done { # returns true on error (non-fatal), undef on success
+ my ($self, $endpoint) = @_;
+ my ($fh, $cmd, $uri) = @{delete $self->{"-get_txt.$endpoint"}};
+ my $cerr = $?;
+ $? = 0; # don't influence normal lei exit
+ return warn("$uri missing\n") if ($cerr >> 8) == 22;
+ return warn("# @$cmd failed (non-fatal)\n") if $cerr;
+ seek($fh, SEEK_SET, 0) or die "seek: $!";
+ $self->{"mtime.$endpoint"} = (stat($fh))[9];
+ local $/;
+ $self->{"txt.$endpoint"} = <$fh>;
+ undef; # success
+}
+
+sub _write_inbox_config {
+ my ($self) = @_;
+ my $buf = delete($self->{'txt._/text/config/raw'}) // return;
+ my $dst = $self->{cur_dst} // $self->{dst};
+ my $f = "$dst/inbox.config.example";
+ open my $fh, '>', $f or die "open($f): $!";
+ print $fh $buf or die "print: $!";
+ chmod(0444 & ~umask, $fh) or die "chmod($f): $!";
+ my $mtime = delete $self->{'mtime._/text/config/raw'};
+ $fh->flush or die "flush($f): $!";
+ if (defined $mtime) {
+ utime($mtime, $mtime, $fh) or die "utime($f): $!";
}
- return $lei->err("# @$cmd failed (non-fatal)") if $cerr;
- rename($f, $ce) or return $lei->err("link($f, $ce): $! (non-fatal)");
- my $cfg = PublicInbox::Config->git_config_dump($f);
+ my $cfg = PublicInbox::Config->git_config_dump($f, $self->{lei}->{2});
my $ibx = $self->{ibx} = {};
for my $sec (grep(/\Apublicinbox\./, @{$cfg->{-section_order}})) {
for (qw(address newsgroup nntpmirror)) {
}
}
+sub set_description ($) {
+ my ($self) = @_;
+ my $dst = $self->{cur_dst} // $self->{dst};
+ my $f = "$dst/description";
+ open my $fh, '+>>', $f or die "open($f): $!";
+ seek($fh, 0, SEEK_SET) or die "seek($f): $!";
+ my $d = do { local $/; <$fh> } // die "read($f): $!";
+ chomp(my $orig = $d);
+ while (defined($d) && ($d =~ m!^\(\$INBOX_DIR/description missing\)! ||
+ $d =~ /^Unnamed repository/ || $d !~ /\S/)) {
+ $d = delete($self->{'txt.description'});
+ }
+ $d //= 'mirror of '.($self->{cur_src} // $self->{src});
+ chomp $d;
+ return if $d eq $orig;
+ seek($fh, 0, SEEK_SET) or die "seek($f): $!";
+ truncate($fh, 0) or die "truncate($f): $!";
+ print $fh $d, "\n" or die "print($f): $!";
+ close $fh or die "close($f): $!";
+}
+
sub index_cloned_inbox {
my ($self, $iv) = @_;
- my $ibx = delete($self->{ibx}) // {
- address => [ 'lei@example.com' ],
- version => $iv,
- };
- $ibx->{inboxdir} = $self->{dst};
- PublicInbox::Inbox->new($ibx);
- PublicInbox::InboxWritable->new($ibx);
- my $opt = {};
my $lei = $self->{lei};
- for my $sw ($lei->index_opt) {
- my ($k) = ($sw =~ /\A([\w-]+)/);
- $opt->{$k} = $lei->{opt}->{$k};
+
+ # n.b. public-inbox-clone works w/o (SQLite || Xapian)
+ # lei is useless without Xapian + SQLite
+ if ($lei->{cmd} ne 'public-inbox-clone') {
+ require PublicInbox::InboxWritable;
+ require PublicInbox::Admin;
+ my $ibx = delete($self->{ibx}) // {
+ address => [ 'lei@example.com' ],
+ version => $iv,
+ };
+ $ibx->{inboxdir} = $self->{cur_dst} // $self->{dst};
+ PublicInbox::Inbox->new($ibx);
+ PublicInbox::InboxWritable->new($ibx);
+ my $opt = {};
+ for my $sw ($lei->index_opt) {
+ my ($k) = ($sw =~ /\A([\w-]+)/);
+ $opt->{$k} = $lei->{opt}->{$k};
+ }
+ # force synchronous dwaitpid for v2:
+ local $PublicInbox::DS::in_loop = 0;
+ my $cfg = PublicInbox::Config->new(undef, $lei->{2});
+ my $env = PublicInbox::Admin::index_prepare($opt, $cfg);
+ local %ENV = (%ENV, %$env) if $env;
+ PublicInbox::Admin::progress_prepare($opt, $lei->{2});
+ PublicInbox::Admin::index_inbox($ibx, undef, $opt);
}
- # force synchronous dwaitpid for v2:
- local $PublicInbox::DS::in_loop = 0;
- my $cfg = PublicInbox::Config->new;
- my $env = PublicInbox::Admin::index_prepare($opt, $cfg);
- local %ENV = (%ENV, %$env) if $env;
- PublicInbox::Admin::progress_prepare($opt, $lei->{2});
- PublicInbox::Admin::index_inbox($ibx, undef, $opt);
- open my $x, '>', "$self->{dst}/mirror.done"; # for do_finish_mirror
+ return if defined $self->{cur_dst}; # one of many repos to clone
+ open my $x, '>', "$self->{dst}/mirror.done"; # for _wq_done_wait
}
sub run_reap {
my ($lei, $cmd, $opt) = @_;
$lei->qerr("# @$cmd");
- $opt->{pgid} = 0;
+ waitpid(spawn($cmd, undef, $opt), 0) // die "waitpid: $!";
+ my $ret = $?;
+ $? = 0; # don't let it influence normal exit
+ $ret;
+}
+
+sub start_clone {
+ my ($self, $cmd, $opt, $fini) = @_;
+ do_reap($self);
+ $self->{lei}->qerr("# @$cmd");
+ return if $self->{dry_run};
+ $LIVE->{spawn($cmd, undef, $opt)} = [ \&reap_cmd, $self, $cmd, $fini ]
+}
+
+sub fetch_args ($$) {
+ my ($lei, $opt) = @_;
+ my @cmd; # (git --git-dir=...) to be added by caller
+ $opt->{$_} = $lei->{$_} for (0..2);
+ # we support "-c $key=$val" for arbitrary git config options
+ # e.g.: git -c http.proxy=socks5h://127.0.0.1:9050
+ push(@cmd, '-c', $_) for @{$lei->{opt}->{c} // []};
+ push @cmd, 'fetch';
+ push @cmd, '-q' if $lei->{opt}->{quiet} ||
+ ($lei->{opt}->{jobs} // 1) > 1;
+ push @cmd, '-v' if $lei->{opt}->{verbose};
+ @cmd;
+}
+
+sub fgrp_update_old ($) { # for git <1.8.5
+ my ($fgrp) = @_;
+ my $cmd = [ @{$fgrp->{-torsocks}}, 'git', "--git-dir=$fgrp->{cur_dst}",
+ fetch_args($fgrp->{lei}, my $opt = {}) ];
+ $fgrp->{lei}->qerr("# @$cmd");
+ do_reap($fgrp);
+ $LIVE->{spawn($cmd, undef, $opt)} = [ \&reap_cmd, $fgrp, $cmd ];
+}
+
+sub upr { # feed `git update-ref --stdin -z' verbosely
+ my ($fgrp, $w, $op, $ref, $oid) = @_;
+ $fgrp->{lei}->qerr("# $op $ref $oid");
+ print $w "$op $ref\0$oid\0" or die "print(w): $!";
+}
+
+sub fgrp_update {
+ my ($fgrp) = @_;
+ my $srcfh = delete $fgrp->{srcfh} or return;
+ my $dstfh = delete $fgrp->{dstfh} or return;
+ seek($srcfh, SEEK_SET, 0) or die "seek(src): $!";
+ seek($dstfh, SEEK_SET, 0) or die "seek(dst): $!";
+ my %src = map { chomp; split(/\0/) } (<$srcfh>);
+ close $srcfh;
+ my %dst = map { chomp; split(/\0/) } (<$dstfh>);
+ close $dstfh;
+ pipe(my ($r, $w)) or die "pipe: $!";
+ my $cmd = [ 'git', "--git-dir=$fgrp->{cur_dst}",
+ qw(update-ref --stdin -z) ];
+ $fgrp->{lei}->qerr("# @$cmd");
+ my $opt = { 0 => $r, 1 => $fgrp->{lei}->{1}, 2 => $fgrp->{lei}->{2} };
my $pid = spawn($cmd, undef, $opt);
- my $reap = PublicInbox::OnDestroy->new($lei->can('sigint_reap'), $pid);
- my $err = waitpid($pid, 0) == $pid ? undef : "waitpid @$cmd: $!";
- @$reap = (); # cancel reap
- $err ? $lei->err($err) : $?
+ close $r or die "close(r): $!";
+ for my $ref (keys %dst) {
+ my $new = delete $src{$ref};
+ my $old = $dst{$ref};
+ if (defined $new) {
+ upr($fgrp, $w, 'update', $ref, $new) if $new ne $old;
+ } else {
+ upr($fgrp, $w, 'delete', $ref, $old);
+ }
+ }
+ while (my ($ref, $oid) = each %src) {
+ upr($fgrp, $w, 'create', $ref, $oid);
+ }
+ if (close($w)) { # git >= 1.8.5
+ $LIVE->{$pid} = [ \&reap_cmd, $fgrp, $cmd ];
+ do_reap($fgrp);
+ } else { # git <1.8.5 w/o update-ref --stdin
+ warn "E: close(update-ref --stdin): $!\n";
+ $update_ref_stdin = 0;
+ waitpid($pid, 0) // die "waitpid(update-ref --stdin): $!";
+ fgrp_update_old($fgrp);
+ }
+}
+
+sub pack_refs {
+ my ($self, $git_dir) = @_;
+ do_reap($self);
+ my $cmd = [ 'git', "--git-dir=$git_dir", qw(pack-refs --all --prune) ];
+ $self->{lei}->qerr("# @$cmd");
+ my $opt = { 1 => $self->{lei}->{1}, 2 => $self->{lei}->{2} };
+ $LIVE->{spawn($cmd, undef, $opt)} = [ \&reap_cmd, $self, $cmd ];
+}
+
+sub fgrp_fetched {
+ my ($fgrp) = @_;
+ return if $fgrp->{dry_run} || !$LIVE;
+ my $rn = $fgrp->{-remote};
+ my %opt = map { $_ => $fgrp->{lei}->{$_} } (0..2);
+ pack_refs($fgrp, $fgrp->{-osdir}); # objstore refs always packed
+
+ $update_ref_stdin or return fgrp_update_old($fgrp);
+
+ my $update_ref = PublicInbox::OnDestroy->new($$, \&fgrp_update, $fgrp);
+
+ my $src = [ 'git', "--git-dir=$fgrp->{-osdir}", 'for-each-ref',
+ "--format=refs/%(refname:lstrip=3)%00%(objectname)",
+ "refs/remotes/$rn/" ];
+ do_reap($fgrp);
+ open($fgrp->{srcfh}, '+>', undef) or die "open(src): $!";
+ $fgrp->{lei}->qerr("# @$src >SRC");
+ my $pid = spawn($src, undef, { %opt, 1 => $fgrp->{srcfh} });
+ $LIVE->{$pid} = [ \&reap_cmd, $fgrp, $src, $update_ref ];
+
+ my $dst = [ 'git', "--git-dir=$fgrp->{cur_dst}", 'for-each-ref',
+ '--format=%(refname)%00%(objectname)' ];
+ do_reap($fgrp);
+ open($fgrp->{dstfh}, '+>', undef) or die "open(dst): $!";
+ $fgrp->{lei}->qerr("# @$dst >DST");
+ $pid = spawn($dst, undef, { %opt, 1 => $fgrp->{dstfh} });
+ $LIVE->{$pid} = [ \&reap_cmd, $fgrp, $dst, $update_ref ];
+}
+
+sub fgrp_fetch {
+ my ($fgrp, $fini) = @_;
+ my $cmd = [ @{$fgrp->{-torsocks}}, 'git', "--git-dir=$fgrp->{-osdir}",
+ fetch_args($fgrp->{lei}, my $opt = {}),
+ $fgrp->{-remote} ];
+ $fgrp->{-fini} = $fini;
+ do_reap($fgrp);
+ $fgrp->{lei}->qerr("# @$cmd");
+ return if $fgrp->{dry_run};
+ my $fgrp_fini = PublicInbox::OnDestroy->new($$, \&fgrp_fetched, $fgrp);
+ my $pid = spawn($cmd, undef, $opt);
+ $LIVE->{$pid} = [ \&reap_cmd, $fgrp, $cmd, $fgrp_fini ];
+}
+
+# keep this idempotent for future use by public-inbox-fetch
+sub forkgroup_prep {
+ my ($self, $uri) = @_;
+ $self->{-ent} // return;
+ my $os = $self->{-objstore} // return;
+ my $fg = $self->{-ent}->{forkgroup} // return;
+ my $dir = "$os/$fg.git";
+ my @cmd = ('git', "--git-dir=$dir", 'config');
+ my $opt = +{ map { $_ => $self->{lei}->{$_} } (0..2) };
+ if (!-d $dir) {
+ PublicInbox::Import::init_bare($dir);
+ for ('repack.useDeltaIslands=true',
+ 'pack.island=refs/remotes/([^/]+)/') {
+ run_die([@cmd, split(/=/, $_, 2)], undef, $opt);
+ }
+ }
+ my $key = $self->{-key} // die 'BUG: no -key';
+ my ($bn) = ($key =~ m{/([a-z0-9_,;=!\+\{\}\|][^/]*)(?:\.git)?\z}i);
+ my $rn = "$bn-".substr(sha256_hex($key), 0, 16);
+ for ("url=$uri", "fetch=+refs/*:refs/remotes/$rn/*") {
+ my @kv = split(/=/, $_, 2);
+ $kv[0] = "remote.$rn.$kv[0]";
+ run_die([@cmd, @kv], undef, $opt);
+ }
+ $self->{-do_pack_refs} = 1; # likely coderepo
+ if (!-d $self->{cur_dst}) {
+ my $alt = File::Spec->rel2abs("$dir/objects");
+ PublicInbox::Import::init_bare($self->{cur_dst});
+ my $o = "$self->{cur_dst}/objects";
+ my $f = "$o/info/alternates";
+ my $l = File::Spec->abs2rel($alt, File::Spec->rel2abs($o));
+ open my $fh, '+>>', $f or die "open($f): $!";
+ seek($fh, SEEK_SET, 0) or die "seek($f): $!";
+ chomp(my @cur = <$fh>);
+ if (!grep(/\A\Q$l\E\z/, @cur)) {
+ say $fh $l or die "say($f): $!";
+ }
+ close $fh or die "close($f): $!";
+ @cmd = ('git', "--git-dir=$self->{cur_dst}",
+ qw(remote add --mirror=fetch origin), "$uri");
+ my $pid = spawn(\@cmd, undef, $opt);
+ waitpid($pid, 0) // die "waitpid(@cmd): $!";
+ die "E: @cmd: \$?=$?" if ($? && ($? >> 8) != 3);
+ }
+ bless { %$self, -osdir => $dir, -remote => $rn }, __PACKAGE__;
}
sub clone_v1 {
- my ($self) = @_;
+ my ($self, $nohang) = @_;
my $lei = $self->{lei};
my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
- my $uri = URI->new($self->{src});
- my $pfx = $curl->torsocks($lei, $uri) or return;
- my $cmd = [ @$pfx, clone_cmd($lei, my $opt = {}),
- $uri->as_string, $self->{dst} ];
- my $cerr = run_reap($lei, $cmd, $opt) // return;
- return $lei->child_error($cerr, "@$cmd failed") if $cerr;
- _try_config($self);
+ my $uri = URI->new($self->{cur_src} // $self->{src});
+ defined($lei->{opt}->{epoch}) and
+ die "$uri is a v1 inbox, --epoch is not supported\n";
+ $self->{-torsocks} //= $curl->torsocks($lei, $uri) or return;
+ my $dst = $self->{cur_dst} // $self->{dst};
+ my $fini = PublicInbox::OnDestroy->new($$, \&v1_done, $self);
+ my $cmd = [ @{$self->{-torsocks}}, clone_cmd($lei, my $opt = {}),
+ "$uri", $dst ];
+ my $fgrp = forkgroup_prep($self, $uri);
+ if (!defined($fgrp) && defined($self->{-ent})) {
+ if (defined(my $ref = $self->{-ent}->{reference})) {
+ -e "$self->{dst}$ref" and
+ push @$cmd, '--reference', "$self->{dst}$ref";
+ }
+ }
+ $fgrp ? fgrp_fetch($fgrp, $fini) :
+ start_clone($self, $cmd, $opt, $fini);
+
+ if (!$self->{-is_epoch} && $lei->{opt}->{'inbox-config'} =~
+ /\A(?:always|v1)\z/s) {
+ _get_txt_start($self, '_/text/config/raw', $fini);
+ }
+
+ my $d = $self->{-ent} ? $self->{-ent}->{description} : undef;
+ $self->{'txt.description'} = $d if defined $d;
+ (!defined($d) && !$nohang) and
+ _get_txt_start($self, 'description', $fini);
+
+ $nohang or do_reap($self, 1); # for non-manifest clone
+}
+
+sub parse_epochs ($$) {
+ my ($opt_epochs, $v2_epochs) = @_; # $epochs "LOW..HIGH"
+ $opt_epochs // return; # undef => all epochs
+ my ($lo, $dotdot, $hi, @extra) = split(/(\.\.)/, $opt_epochs);
+ undef($lo) if ($lo // '') eq '';
+ my $re = qr/\A~?[0-9]+\z/;
+ if (@extra || (($lo // '0') !~ $re) ||
+ (($hi // '0') !~ $re) ||
+ !(grep(defined, $lo, $hi))) {
+ die <<EOM;
+--epoch=$opt_epochs not in the form of `LOW..HIGH', `LOW..', nor `..HIGH'
+EOM
+ }
+ my @n = sort { $a <=> $b } keys %$v2_epochs;
+ for (grep(defined, $lo, $hi)) {
+ if (/\A[0-9]+\z/) {
+ $_ > $n[-1] and die
+"`$_' exceeds maximum available epoch ($n[-1])\n";
+ $_ < $n[0] and die
+"`$_' is lower than minimum available epoch ($n[0])\n";
+ } elsif (/\A~([0-9]+)/) {
+ my $off = -$1 - 1;
+ $n[$off] // die "`$_' is out of range\n";
+ $_ = $n[$off];
+ } else { die "`$_' not understood\n" }
+ }
+ defined($lo) && defined($hi) && $lo > $hi and die
+"low value (`$lo') exceeds high (`$hi')\n";
+ $lo //= $n[0] if $dotdot;
+ $hi //= $n[-1] if $dotdot;
+ $hi //= $lo;
+ my $want = {};
+ for ($lo..$hi) {
+ if (defined $v2_epochs->{$_}) {
+ $want->{$_} = 1;
+ } else {
+ warn
+"# epoch $_ is not available (non-fatal, $lo..$hi)\n";
+ }
+ }
+ $want
+}
+
+sub init_placeholder ($$$) {
+ my ($src, $edst, $ent) = @_;
+ PublicInbox::Import::init_bare($edst);
+ my $f = "$edst/config";
+ open my $fh, '>>', $f or die "open($f): $!";
+ print $fh <<EOM or die "print($f): $!";
+[remote "origin"]
+ url = $src
+ fetch = +refs/*:refs/*
+ mirror = true
+
+; This git epoch was created read-only and "public-inbox-fetch"
+; will not fetch updates for it unless write permission is added.
+; Hint: chmod +w $edst
+EOM
+ if (defined($ent->{owner})) {
+ print $fh <<EOM or die "print($f): $!";
+[gitweb]
+ owner = $ent->{owner}
+EOM
+ }
+ close $fh or die "close($f): $!";
+ my %map = (head => 'HEAD', description => undef);
+ while (my ($key, $fn) = each %map) {
+ my $val = $ent->{$key} // next;
+ $fn //= $key;
+ $fn = "$edst/$fn";
+ open $fh, '>', $fn or die "open($fn): $!";
+ print $fh $val, "\n" or die "print($fn): $!";
+ close $fh or die "close($fn): $!";
+ }
+}
+
+sub reap_cmd { # async, called via SIGCHLD
+ my ($self, $cmd) = @_;
+ my $cerr = $?;
+ $? = 0; # don't let it influence normal exit
+ if ($cerr) {
+ kill('TERM', keys %$LIVE);
+ $self->{lei}->child_error($cerr, "@$cmd failed");
+ }
+}
+
+sub v1_done { # called via OnDestroy
+ my ($self) = @_;
+ return if $self->{dry_run} || !$LIVE;
+ _write_inbox_config($self);
+ my $dst = $self->{cur_dst} // $self->{dst};
+ if (defined(my $o = $self->{-ent} ? $self->{-ent}->{owner} : undef)) {
+ run_die([qw(git config -f), "$dst/config", 'gitweb.owner', $o]);
+ }
+ my $o = "$dst/objects";
+ if (open(my $fh, '<', "$o/info/alternates")) {
+ my $base = File::Spec->rel2abs($o);
+ chomp(my @l = <$fh>);
+ for (@l) {
+ $_ = File::Spec->abs2rel($_, $base) if m!\A/!;
+ $_ .= "\n";
+ }
+ my $f = File::Temp->new(TEMPLATE => '.XXXX', DIR => "$o/info");
+ print $f @l;
+ $f->flush or die "flush($f): $!";
+ rename($f->filename, "$o/info/alternates") or
+ die "rename($f, $o/info/alternates): $!";
+ $f->unlink_on_destroy(0);
+ }
+ pack_refs($self, $dst) if delete $self->{-do_pack_refs};
+ eval { set_description($self) };
+ warn $@ if $@;
+ return if ($self->{-is_epoch} ||
+ $self->{lei}->{opt}->{'inbox-config'} ne 'always');
+ write_makefile($dst, 1);
index_cloned_inbox($self, 1);
}
-sub clone_v2 {
- my ($self, $v2_uris) = @_;
+sub v2_done { # called via OnDestroy
+ my ($self) = @_;
+ return if $self->{dry_run} || !$LIVE;
+ my $dst = $self->{cur_dst} // $self->{dst};
+ require PublicInbox::Lock;
+ my $lk = bless { lock_path => "$dst/inbox.lock" }, 'PublicInbox::Lock';
+ my $lck = $lk->lock_for_scope($$);
+ _write_inbox_config($self);
+ require PublicInbox::MultiGit;
+ my $mg = PublicInbox::MultiGit->new($dst, 'all.git', 'git');
+ $mg->fill_alternates;
+ for my $i ($mg->git_epochs) { $mg->epoch_cfg_set($i) }
+ for my $edst (@{delete($self->{-read_only}) // []}) {
+ my @st = stat($edst) or die "stat($edst): $!";
+ chmod($st[2] & 0555, $edst) or die "chmod(a-w, $edst): $!";
+ }
+ write_makefile($dst, 2);
+ undef $lck; # unlock
+ eval { set_description($self) };
+ warn $@ if $@;
+ index_cloned_inbox($self, 2);
+}
+
+sub clone_v2_prep ($$;$) {
+ my ($self, $v2_epochs, $m) = @_; # $m => manifest.js.gz hashref
my $lei = $self->{lei};
my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
- my $pfx //= $curl->torsocks($lei, $v2_uris->[0]) or return;
- my @epochs;
- my $dst = $self->{dst};
- my @src_edst;
- for my $uri (@$v2_uris) {
+ my $first_uri = (map { $_->[0] } values %$v2_epochs)[0];
+ $self->{-torsocks} //= $curl->torsocks($lei, $first_uri) or return;
+ my $dst = $self->{cur_dst} // $self->{dst};
+ my $want = parse_epochs($lei->{opt}->{epoch}, $v2_epochs);
+ my $task = $m ? bless { %$self }, __PACKAGE__ : $self;
+ delete $task->{todo}; # $self->{todo} still exists
+ my (@skip, $desc);
+ my $fini = PublicInbox::OnDestroy->new($$, \&v2_done, $task);
+ for my $nr (sort { $a <=> $b } keys %$v2_epochs) {
+ my ($uri, $key) = @{$v2_epochs->{$nr}};
my $src = $uri->as_string;
my $edst = $dst;
$src =~ m!/([0-9]+)(?:\.git)?\z! or die <<"";
failed to extract epoch number from $src
- my $nr = $1 + 0;
+ $1 + 0 == $nr or die "BUG: <$uri> miskeyed $1 != $nr";
$edst .= "/git/$nr.git";
- push @src_edst, [ $src, $edst ];
+ my $ent;
+ if ($m) {
+ $ent = $m->{$key} //
+ die("BUG: `$key' not in manifest.js.gz");
+ if (defined(my $d = $ent->{description})) {
+ $d =~ s/ \[epoch [0-9]+\]\z//s;
+ $desc = $d;
+ }
+ }
+ if (!$want || $want->{$nr}) {
+ my $etask = bless { %$task, -key => $key }, __PACKAGE__;
+ $etask->{-ent} = $ent; # may have {reference}
+ $etask->{cur_src} = $src;
+ $etask->{cur_dst} = $edst;
+ $etask->{-is_epoch} = $fini;
+ my $ref = $ent->{reference} // '';
+ push @{$self->{todo}->{$ref}}, $etask;
+ $self->{any_want}->{$key} = 1;
+ } else { # create a placeholder so users only need to chmod +w
+ init_placeholder($src, $edst, $ent);
+ push @{$task->{-read_only}}, $edst;
+ push @skip, $key;
+ }
}
- my $lk = bless { lock_path => "$dst/inbox.lock" }, 'PublicInbox::Lock';
- _try_config($self);
- my $on_destroy = $lk->lock_for_scope($$);
- my @cmd = clone_cmd($lei, my $opt = {});
- while (my $pair = shift(@src_edst)) {
- my $cmd = [ @$pfx, @cmd, @$pair ];
- my $cerr = run_reap($lei, $cmd, $opt) // return;
- return $lei->child_error($cerr, "@$cmd failed") if $cerr;
- }
- undef $on_destroy; # unlock
- index_cloned_inbox($self, 2);
+ # filter out the epochs we skipped
+ $self->{-culled_manifest} = 1 if $m && delete(@$m{@skip});
+
+ (!$self->{dry_run} && !-d $dst) and File::Path::mkpath($dst);
+
+ $lei->{opt}->{'inbox-config'} =~ /\A(?:always|v2)\z/s and
+ _get_txt_start($task, '_/text/config/raw', $fini);
+
+ defined($desc) ? ($task->{'txt.description'} = $desc) :
+ _get_txt_start($task, 'description', $fini);
+}
+
+sub decode_manifest ($$$) {
+ my ($fh, $fn, $uri) = @_;
+ my $js;
+ my $gz = do { local $/; <$fh> } // die "slurp($fn): $!";
+ gunzip(\$gz => \$js, MultiStream => 1) or
+ die "gunzip($uri): $GunzipError\n";
+ my $m = eval { PublicInbox::Config->json->decode($js) };
+ die "$uri: error decoding `$js': $@\n" if $@;
+ ref($m) eq 'HASH' or die "$uri unknown type: ".ref($m);
+ $m;
+}
+
+sub multi_inbox ($$$) {
+ my ($self, $path, $m) = @_;
+ my $incl = $self->{lei}->{opt}->{include};
+ my $excl = $self->{lei}->{opt}->{exclude};
+
+ # assuming everything not v2 is v1, for now
+ my @v1 = sort grep(!m!.+/git/[0-9]+\.git\z!, keys %$m);
+ my @v2_epochs = sort grep(m!.+/git/[0-9]+\.git\z!, keys %$m);
+ my $v2 = {};
+
+ for (@v2_epochs) {
+ m!\A(/.+)/git/[0-9]+\.git\z! or die "BUG: $_";
+ push @{$v2->{$1}}, $_;
+ }
+ my $n = scalar(keys %$v2) + scalar(@v1);
+ my @orig = defined($incl // $excl) ? (keys %$v2, @v1) : ();
+ if (defined $incl) {
+ my $re = '(?:'.join('\\z|', map {
+ $self->{lei}->glob2re($_) // qr/\A\Q$_\E/
+ } @$incl).'\\z)';
+ my @gone = delete @$v2{grep(!/$re/, keys %$v2)};
+ delete @$m{map { @$_ } @gone} and $self->{-culled_manifest} = 1;
+ delete @$m{grep(!/$re/, @v1)} and $self->{-culled_manifest} = 1;
+ @v1 = grep(/$re/, @v1);
+ }
+ if (defined $excl) {
+ my $re = '(?:'.join('\\z|', map {
+ $self->{lei}->glob2re($_) // qr/\A\Q$_\E/
+ } @$excl).'\\z)';
+ my @gone = delete @$v2{grep(/$re/, keys %$v2)};
+ delete @$m{map { @$_ } @gone} and $self->{-culled_manifest} = 1;
+ delete @$m{grep(/$re/, @v1)} and $self->{-culled_manifest} = 1;
+ @v1 = grep(!/$re/, @v1);
+ }
+ my $ret; # { v1 => [ ... ], v2 => { "/$inbox_name" => [ epochs ] }}
+ $ret->{v1} = \@v1 if @v1;
+ $ret->{v2} = $v2 if keys %$v2;
+ $ret //= @orig ? "Nothing to clone, available repositories:\n\t".
+ join("\n\t", sort @orig)
+ : "Nothing available to clone\n";
+ my $path_pfx = '';
+
+ # PSGI mount prefixes and manifest.js.gz prefixes don't always align...
+ if (@v2_epochs) {
+ until (grep(m!\A\Q$$path\E/git/[0-9]+\.git\z!,
+ @v2_epochs) == @v2_epochs) {
+ $$path =~ s!\A(/[^/]+)/!/! or last;
+ $path_pfx .= $1;
+ }
+ } elsif (@v1) {
+ while (!defined($m->{$$path}) && $$path =~ s!\A(/[^/]+)/!/!) {
+ $path_pfx .= $1;
+ }
+ }
+ ($path_pfx, $n, $ret);
}
+sub clone_all {
+ my ($self, $m) = @_;
+ my $todo = delete $self->{todo};
+ my $nodep = delete $todo->{''};
+
+ # do not download unwanted deps
+ my $any_want = delete $self->{any_want};
+ my @unwanted = grep { !$any_want->{$_} } keys %$todo;
+ my @nodep = delete(@$todo{@unwanted});
+ push(@$nodep, @$_) for @nodep;
+
+ # handle no-dependency repos, first
+ for (@$nodep) {
+ clone_v1($_, 1);
+ return if $self->{lei}->{child_error};
+ }
+ # resolve references, deepest, first:
+ while (scalar keys %$todo) {
+ for my $x (keys %$todo) {
+ my ($nr, $nxt);
+ # resolve multi-level references
+ while ($m && defined($nxt = $m->{$x}->{reference})) {
+ exists($todo->{$nxt}) or last;
+ die <<EOM if ++$nr > 1000;
+E: dependency loop detected (`$x' => `$nxt')
+EOM
+ $x = $nxt;
+ }
+ my $y = delete $todo->{$x} // next; # already done
+ for (@$y) {
+ clone_v1($_, 1);
+ return if $self->{lei}->{child_error};
+ }
+ last; # restart %$todo iteration
+ }
+ }
+ do_reap($self, 1);
+}
+
+sub dump_manifest ($$) {
+ my ($m, $ft) = @_;
+ # write the smaller manifest if epochs were skipped so
+ # users won't have to delete manifest if they +w an
+ # epoch they no longer want to skip
+ my $json = PublicInbox::Config->json->encode($m);
+ my $mtime = (stat($ft))[9];
+ seek($ft, SEEK_SET, 0) or die "seek($ft): $!";
+ truncate($ft, 0) or die "truncate($ft): $!";
+ gzip(\$json => $ft) or die "gzip($ft): $GzipError";
+ $ft->flush or die "flush($ft): $!";
+ utime($mtime, $mtime, "$ft") or die "utime(..., $ft): $!";
+}
+
+# FIXME: this gets confused by single inbox instance w/ global manifest.js.gz
sub try_manifest {
my ($self) = @_;
my $uri = URI->new($self->{src});
my $path = $uri->path;
chop($path) eq '/' or die "BUG: $uri not canonicalized";
$uri->path($path . '/manifest.js.gz');
- my $cmd = $curl->for_uri($lei, $uri);
- $lei->qerr("# @$cmd");
- my $opt = { 0 => $lei->{0}, 2 => $lei->{2} };
- my ($fh, $pid) = popen_rd($cmd, undef, $opt);
- my $reap = PublicInbox::OnDestroy->new($lei->can('sigint_reap'), $pid);
- my $gz = do { local $/; <$fh> } // die "read(curl $uri): $!";
- close $fh;
- my $err = waitpid($pid, 0) == $pid ? undef : "waitpid @$cmd: $!";
- @$reap = ();
- return $lei->err($err) if $err;
- if ($?) {
- return try_scrape($self) if ($? >> 8) == 22; # 404 missing
- return $lei->child_error($?, "@$cmd failed");
+ my $ft = File::Temp->new(TEMPLATE => '.manifest-XXXX',
+ UNLINK => 1, TMPDIR => 1, SUFFIX => '.tmp');
+ my $cmd = $curl->for_uri($lei, $uri, qw(-f -R -o), $ft->filename);
+ my %opt = map { $_ => $lei->{$_} } (0..2);
+ my $cerr = run_reap($lei, $cmd, \%opt);
+ if ($cerr) {
+ return try_scrape($self) if ($cerr >> 8) == 22; # 404 missing
+ return $lei->child_error($cerr, "@$cmd failed");
}
- my $js;
- gunzip(\$gz => \$js, MultiStream => 1) or
- die "gunzip($uri): $GunzipError";
- my $m = eval { PublicInbox::Config->json->decode($js) };
- die "$uri: error decoding `$js': $@" if $@;
- ref($m) eq 'HASH' or die "$uri unknown type: ".ref($m);
-
- my $v1_bare = $m->{$path};
- my @v2_epochs = grep(m!\A\Q$path\E/git/[0-9]+\.git\z!, keys %$m);
- if (@v2_epochs) {
- # It may be possible to have v1 + v2 in parallel someday:
- $lei->err(<<EOM) if defined $v1_bare;
-# `$v1_bare' appears to be a v1 inbox while v2 epochs exist:
-# @v2_epochs
-# ignoring $v1_bare (use --inbox-version=1 to force v1 instead)
+ my $m = eval { decode_manifest($ft, $ft, $uri) };
+ if ($@) {
+ warn $@;
+ return try_scrape($self);
+ }
+ my ($path_pfx, $n, $multi) = multi_inbox($self, \$path, $m);
+ return $lei->child_error(1, $multi) if !ref($multi);
+ my $v2 = delete $multi->{v2};
+ local $self->{todo} = {};
+ if ($v2) {
+ for my $name (sort keys %$v2) {
+ my $epochs = delete $v2->{$name};
+ my %v2_epochs = map {
+ $uri->path($n > 1 ? $path_pfx.$path.$_
+ : $path_pfx.$_);
+ my ($e) = ("$uri" =~ m!/([0-9]+)\.git\z!);
+ $e // die "no [0-9]+\.git in `$uri'";
+ $e => [ $uri->clone, $_ ];
+ } @$epochs;
+ ("$uri" =~ m!\A(.+/)git/[0-9]+\.git\z!) or
+ die "BUG: `$uri' !~ m!/git/[0-9]+.git!";
+ local $self->{cur_src} = $1;
+ local $self->{cur_dst} = $self->{dst};
+ if ($n > 1 && $uri->path =~ m!\A\Q$path_pfx$path\E/(.+)/
+ git/[0-9]+\.git\z!x) {
+ $self->{cur_dst} .= "/$1";
+ }
+ index($self->{cur_dst}, "\n") >= 0 and die <<EOM;
+E: `$self->{cur_dst}' must not contain newline
EOM
- @v2_epochs = map { $uri->path($_); $uri->clone } @v2_epochs;
- clone_v2($self, \@v2_epochs);
- } elsif ($v1_bare) {
- clone_v1($self);
- } elsif (my @maybe = grep(m!\Q$path\E!, keys %$m)) {
- die "E: confused by <$uri>, possible matches:\n@maybe";
- } else {
- die "E: confused by <$uri>";
+ clone_v2_prep($self, \%v2_epochs, $m);
+ return if $self->{lei}->{child_error};
+ }
}
+ if (my $v1 = delete $multi->{v1}) {
+ my $p = $path_pfx.$path;
+ chop($p) if substr($p, -1, 1) eq '/';
+ $uri->path($p);
+ for my $name (@$v1) {
+ my $task = bless { %$self }, __PACKAGE__;
+ $task->{-ent} = $m->{$name} //
+ die("BUG: no `$name' in manifest");
+ $task->{cur_src} = "$uri";
+ $task->{cur_dst} = $task->{dst};
+ $task->{-key} = $name;
+ if ($n > 1) {
+ $task->{cur_dst} .= $name;
+ $task->{cur_src} .= $name;
+ }
+ index($task->{cur_dst}, "\n") >= 0 and die <<EOM;
+E: `$task->{cur_dst}' must not contain newline
+EOM
+ $task->{cur_src} .= '/';
+ my $dep = $task->{-ent}->{reference} // '';
+ push @{$self->{todo}->{$dep}}, $task; # for clone_all
+ $self->{any_want}->{$name} = 1;
+ }
+ }
+ delete local $lei->{opt}->{epoch} if defined($v2);
+ clone_all($self, $m);
+ return if $self->{lei}->{child_error} || $self->{dry_run};
+
+ # set by clone_v2_prep/-I/--exclude
+ dump_manifest($m => $ft) if delete $self->{-culled_manifest};
+ ft_rename($ft, "$self->{dst}/manifest.js.gz", 0666);
+ open my $x, '>', "$self->{dst}/mirror.done"; # for _wq_done_wait
}
sub start_clone_url {
die "TODO: non-HTTP/HTTPS clone of $self->{src} not supported, yet";
}
-sub do_mirror { # via wq_io_do
+sub do_mirror { # via wq_io_do or public-inbox-clone
my ($self) = @_;
my $lei = $self->{lei};
+ umask($lei->{client_umask}) if defined $lei->{client_umask};
eval {
- my $iv = $lei->{opt}->{'inbox-version'};
- if (defined $iv) {
- return clone_v1($self) if $iv == 1;
- return try_scrape($self) if $iv == 2;
- die "bad --inbox-version=$iv\n";
+ my $ic = $lei->{opt}->{'inbox-config'} //= 'always';
+ $ic =~ /\A(?:v1|v2|always|never)\z/s or die <<"";
+--inbox-config must be one of `always', `v2', `v1', or `never'
+
+ if (defined(my $os = $lei->{opt}->{objstore})) {
+ $os = 'objstore' if $os eq ''; # --objstore w/o args
+ $os = "$self->{dst}/$os" if $os !~ m!\A/!;
+ $self->{-objstore} = $os;
}
- return start_clone_url($self) if $self->{src} =~ m!://!;
- die "TODO: cloning local directories not supported, yet";
+ local $LIVE;
+ my $iv = $lei->{opt}->{'inbox-version'} //
+ return start_clone_url($self);
+ return clone_v1($self) if $iv == 1;
+ die "bad --inbox-version=$iv\n" if $iv != 2;
+ die <<EOM if $self->{src} !~ m!://!;
+cloning local v2 inboxes not supported
+EOM
+ try_scrape($self, 1);
};
$lei->fail($@) if $@;
}
sub start {
my ($cls, $lei, $src, $dst) = @_;
my $self = bless { src => $src, dst => $dst }, $cls;
- if ($src =~ m!https?://!) {
- require URI;
- require PublicInbox::LeiCurl;
- }
- require PublicInbox::Lock;
- require PublicInbox::Inbox;
- require PublicInbox::Admin;
- require PublicInbox::InboxWritable;
- my ($op, $ops) = $lei->workers_start($self, 'lei_mirror', 1);
+ $lei->request_umask;
+ my ($op_c, $ops) = $lei->workers_start($self, 1);
$lei->{wq1} = $self;
$self->wq_io_do('do_mirror', []);
- $self->wq_close(1);
- $op->op_wait_event($ops);
+ $self->wq_close;
+ $lei->wait_wq_events($op_c, $ops);
}
sub ipc_atfork_child {
my ($self) = @_;
$self->{lei}->_lei_atfork_child;
- $SIG{TERM} = sub { exit(128 + 15) }; # trigger OnDestroy $reap
$self->SUPER::ipc_atfork_child;
}
+sub write_makefile {
+ my ($dir, $ibx_ver) = @_;
+ my $f = "$dir/Makefile";
+ if (sysopen my $fh, $f, O_CREAT|O_EXCL|O_WRONLY) {
+ print $fh <<EOM or die "print($f) $!";
+# This is a v$ibx_ver public-inbox, see the public-inbox-v$ibx_ver-format(5)
+# manpage for more information on the format. This Makefile is
+# intended as a familiar wrapper for users unfamiliar with
+# public-inbox-* commands.
+#
+# See the respective manpages for public-inbox-fetch(1),
+# public-inbox-index(1), etc for more information on
+# some of the commands used by this Makefile.
+#
+# This Makefile will not be modified nor read by public-inbox,
+# so you may edit it freely with your own convenience targets
+# and notes. public-inbox-fetch will recreate it if removed.
+EOM
+ print $fh <<'EOM' or die "print($f): $!";
+# the default target:
+help :
+ @echo Common targets:
+ @echo ' make fetch - fetch from remote git repostorie(s)'
+ @echo ' make update - fetch and update index '
+ @echo
+ @echo Rarely needed targets:
+ @echo ' make reindex - may be needed for new features/bugfixes'
+ @echo ' make compact - rewrite Xapian storage to save space'
+ @echo ' make index - initial index after clone
+
+fetch :
+ public-inbox-fetch
+update :
+ @if ! public-inbox-fetch --exit-code; \
+ then \
+ c=$$?; \
+ test $$c -eq 127 && exit 0; \
+ exit $$c; \
+ elif test -f msgmap.sqlite3 || test -f public-inbox/msgmap.sqlite3; \
+ then \
+ public-inbox-index; \
+ else \
+ echo 'public-inbox index not initialized'; \
+ echo 'see public-inbox-index(1) man page'; \
+ fi
+index :
+ public-inbox-index
+reindex :
+ public-inbox-index --reindex
+compact :
+ public-inbox-compact
+
+.PHONY : help fetch update index reindex compact
+EOM
+ close $fh or die "close($f): $!";
+ } else {
+ die "open($f): $!" unless $!{EEXIST};
+ }
+}
+
1;