]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/LeiMirror.pm
clone|--mirror: fix and test against pre-manifest WWW
[public-inbox.git] / lib / PublicInbox / LeiMirror.pm
index c113c9debf8bfccdc0834e09cd1c56d05f167f3c..fe81b967fd4ae990c97d1db6769a7515e5e5f53e 100644 (file)
@@ -9,9 +9,9 @@ use parent qw(PublicInbox::IPC);
 use IO::Uncompress::Gunzip qw(gunzip $GunzipError);
 use PublicInbox::Spawn qw(popen_rd spawn run_die);
 use File::Temp ();
-use Fcntl qw(SEEK_SET);
+use Fcntl qw(SEEK_SET O_CREAT O_EXCL O_WRONLY);
 
-sub do_finish_mirror { # dwaitpid callback
+sub _wq_done_wait { # dwaitpid callback (via wq_eof)
        my ($arg, $pid) = @_;
        my ($mrr, $lei) = @$arg;
        my $f = "$mrr->{dst}/mirror.done";
@@ -28,12 +28,6 @@ sub do_finish_mirror { # dwaitpid callback
        $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) = @_;
@@ -48,15 +42,19 @@ sub try_scrape {
 
        # 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);
+       my @html = split(/<hr>/, $html);
+       my @urls = ($html[-1] =~ m!\bgit clone --mirror ([a-z\+]+://\S+)!g);
        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
+               return clone_v2($self, \%v2_epochs);
        }
 
        # filter out common URLs served by WWW (e.g /$MSGID/T/)
@@ -176,18 +174,20 @@ sub index_cloned_inbox {
                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
+       open my $x, '>', "$self->{dst}/mirror.done"; # for _wq_done_wait
 }
 
 sub run_reap {
        my ($lei, $cmd, $opt) = @_;
-       $lei->qerr("# @$cmd" . ($opt->{-C} ? " (in $opt->{-C})" : ''));
+       $lei->qerr("# @$cmd");
        $opt->{pgid} = 0 if $lei->{sock};
        my $pid = spawn($cmd, undef, $opt);
        my $reap = PublicInbox::OnDestroy->new($lei->can('sigint_reap'), $pid);
        waitpid($pid, 0) == $pid or die "waitpid @$cmd: $!";
        @$reap = (); # cancel reap
-       $?
+       my $ret = $?;
+       $? = 0; # don't let it influence normal exit
+       $ret;
 }
 
 sub clone_v1 {
@@ -195,31 +195,101 @@ sub clone_v1 {
        my $lei = $self->{lei};
        my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
        my $uri = URI->new($self->{src});
+       defined($lei->{opt}->{epoch}) and
+               die "$uri is a v1 inbox, --epoch is not supported\n";
        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 $lei->child_error($cerr, "@$cmd failed") if $cerr;
        _try_config($self);
+       write_makefile($self->{dst}, 1);
        index_cloned_inbox($self, 1);
 }
 
-sub clone_v2 {
-       my ($self, $v2_uris) = @_;
+sub parse_epochs ($$) {
+       my ($opt_epochs, $v2_epochs) = @_; # $epcohs "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) = @_;
+       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.
+EOM
+       close $fh or die "close:($f): $!";
+}
+
+sub clone_v2 ($$) {
+       my ($self, $v2_epochs) = @_;
        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 $pfx = $curl->torsocks($lei, (values %$v2_epochs)[0]) or return;
        my $dst = $self->{dst};
-       my @src_edst;
-       for my $uri (@$v2_uris) {
+       my $want = parse_epochs($lei->{opt}->{epoch}, $v2_epochs);
+       my (@src_edst, @read_only);
+       for my $nr (sort { $a <=> $b } keys %$v2_epochs) {
+               my $uri = $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;
+               if (!$want || $want->{$nr}) {
+                       push @src_edst, $src, $edst;
+               } else { # create a placeholder so users only need to chmod +w
+                       init_placeholder($src, $edst);
+                       push @read_only, $edst;
+               }
        }
        my $lk = bless { lock_path => "$dst/inbox.lock" }, 'PublicInbox::Lock';
        _try_config($self);
@@ -234,6 +304,11 @@ failed to extract epoch number from $src
        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 (@read_only) {
+               my @st = stat($edst) or die "stat($edst): $!";
+               chmod($st[2] & 0555, $edst) or die "chmod(a-w, $edst): $!";
+       }
+       write_makefile($self->{dst}, 2);
        undef $on_destroy; # unlock
        index_cloned_inbox($self, 2);
 }
@@ -274,17 +349,23 @@ sub try_manifest {
        $uri->path($path . '/manifest.js.gz');
        my $pdir = $lei->rel2abs($self->{dst});
        $pdir =~ s!/[^/]+/?\z!!;
-       my $ft = File::Temp->new(TEMPLATE => 'manifest-XXXX',
-                               UNLINK => 1, DIR => $pdir);
+       my $ft = File::Temp->new(TEMPLATE => 'm-XXXX',
+                               UNLINK => 1, DIR => $pdir, SUFFIX => '.tmp');
        my $fn = $ft->filename;
-       my $cmd = $curl->for_uri($lei, $uri, '-R', '-o', $fn);
-       my $opt = { 0 => $lei->{0}, 1 => $lei->{1}, 2 => $lei->{2} };
+       my ($bn) = ($fn =~ m!/([^/]+)\z!);
+       my $cmd = $curl->for_uri($lei, $uri, '-R', '-o', $bn);
+       my $opt = { -C => $pdir };
+       $opt->{$_} = $lei->{$_} for (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 $m = decode_manifest($ft, $fn, $uri);
+       my $m = eval { decode_manifest($ft, $fn, $uri) };
+       if ($@) {
+               warn $@;
+               return try_scrape($self);
+       }
        my ($path_pfx, $v1_path, @v2_epochs) = deduce_epochs($m, $path);
        if (@v2_epochs) {
                # It may be possible to have v1 + v2 in parallel someday:
@@ -293,11 +374,12 @@ sub try_manifest {
 # @v2_epochs
 # ignoring $v1_path (use --inbox-version=1 to force v1 instead)
 EOM
-               @v2_epochs = map {
+               my %v2_epochs = map {
                        $uri->path($path_pfx.$_);
-                       $uri->clone
+                       my ($n) = ("$uri" =~ m!/([0-9]+)\.git\z!);
+                       $n => $uri->clone
                } @v2_epochs;
-               clone_v2($self, \@v2_epochs);
+               clone_v2($self, \%v2_epochs);
        } elsif (defined $v1_path) {
                clone_v1($self);
        } else {
@@ -356,4 +438,61 @@ sub ipc_atfork_child {
        $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'
+
+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
+reindex :
+       public-inbox-index --reindex
+compact :
+       public-inbox-compact
+
+.PHONY : help fetch update reindex compact
+EOM
+               close $fh or die "close($f): $!";
+       } else {
+               die "open($f): $!" unless $!{EEXIST};
+       }
+}
+
 1;