public-inbox.git  about / heads / tags
an "archives first" approach to mailing lists
blob 5353ae61c40249d65a7cdffc4b9862681f1fa8cd 43119 bytes (raw)
$ git show HEAD:lib/PublicInbox/LeiMirror.pm	# shows this blob on the CLI

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
 
# 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 (also "public-inbox-clone");
package PublicInbox::LeiMirror;
use v5.12;
use parent qw(PublicInbox::IPC);
use IO::Uncompress::Gunzip qw(gunzip $GunzipError);
use IO::Compress::Gzip qw(gzip $GzipError);
use PublicInbox::Spawn qw(spawn run_wait run_die run_qx);
use PublicInbox::IO qw(write_file);
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 qw(glob2re);
use PublicInbox::Inbox;
use PublicInbox::LeiCurl;
use PublicInbox::OnDestroy;
use PublicInbox::SHA qw(sha256_hex sha_all);
use POSIX qw(strftime);
use PublicInbox::Admin qw(fmt_localtime);
use autodie qw(chdir chmod close open pipe readlink
		seek symlink sysopen sysseek truncate unlink);

our $LIVE; # pid => callback
our $FGRP_TODO; # objstore -> [[ to resume ], [ to clone ]]
our $TODO; # reference => [ non-fgrp mirror objects ]
our @PUH; # post-update hooks

sub keep_going ($) {
	$LIVE && (!$_[0]->{lei}->{child_error} ||
		$_[0]->{lei}->{opt}->{'keep-going'});
}

sub _wq_done_wait { # awaitpid cb (via wq_eof)
	my ($pid, $mrr, $lei) = @_;
	if ($?) {
		$lei->child_error($?);
	} elsif (!$lei->{child_error}) {
		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;
}

# for old installations without manifest.js.gz
sub try_scrape {
	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 $opt = { 0 => $lei->{0}, 2 => $lei->{2} };
	my $html = run_qx($cmd, undef, $opt);
	return $lei->child_error($?, "@$cmd failed") if $?;

	# we grep with URL below, we don't want Subject/From headers
	# 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_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/)
	if (@urls && $url =~ s!/+[^/]+\@[^/]+/.*\z!! &&
			grep(m!\A\Q$url\E/*\z!, @urls)) {
		die <<"";
E: confused by scraping <$uri>, did you mean <$url>?

	}
	@urls and die <<"";
E: confused by scraping <$uri>, got ambiguous results:
@urls

	die "E: scraping <$uri> revealed nothing\n";
}

sub clone_cmd {
	my ($lei, $opt) = @_;
	my @cmd = qw(git);
	$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, qw(clone --mirror);
	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, but handled
	# automatically if using manifest.js.gz
	@cmd;
}

sub ft_rename ($$$;$) {
	my ($ft, $dst, $open_mode, $fh) = @_;
	my @st = stat($fh // $dst);
	my $mode = @st ? ($st[2] & 07777) : ($open_mode & ~umask);
	chmod($mode, $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";
		}
	}
}

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/$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(--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, 0, SEEK_SET);
	$self->{"mtime.$endpoint"} = (stat($fh))[9];
	$self->{"txt.$endpoint"} = PublicInbox::IO::read_all $fh, -s _;
	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";
	my $mtime = delete $self->{'mtime._/text/config/raw'};
	if (CORE::sysopen(my $fh, $f, O_CREAT|O_EXCL|O_WRONLY)) {
		print $fh $buf;
		chmod(0444 & ~umask, $fh);
		$fh->flush or die "flush($f): $!";
		if (defined $mtime) {
			utime($mtime, $mtime, $fh) or die "utime($f): $!";
		}
	} elsif (!$!{EEXIST}) {
		die "open($f): $!";
	}
	my $cfg = PublicInbox::Config->git_config_dump($f,
						{ 2 => $self->{lei}->{2} });
	my $ibx = $self->{ibx} = {}; # for indexing
	for my $sec (grep(/\Apublicinbox\./, @{$cfg->{-section_order}})) {
		for (qw(address newsgroup nntpmirror)) {
			$ibx->{$_} = $cfg->{"$sec.$_"};
		}
	}
}

sub set_description ($) {
	my ($self) = @_;
	my $dst = $self->{cur_dst} // $self->{dst};
	chomp(my $orig = PublicInbox::IO::try_cat("$dst/description"));
	my $d = $orig;
	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});
	atomic_write($dst, 'description', $d."\n") if $d ne $orig;
}

sub index_cloned_inbox {
	my ($self, $iv) = @_;
	my $lei = $self->{lei};

	# 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 awaitpid for v2:
		local $PublicInbox::DS::in_loop = 0;
		my $cfg = PublicInbox::Config->new(undef, { 2 => $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);
	}
	return if defined $self->{cur_dst}; # one of many repos to clone
}

sub run_reap {
	my ($lei, $cmd, $opt) = @_;
	$lei->qerr("# @$cmd");
	my $ret = run_wait($cmd, undef, $opt);
	$? = 0; # don't let it influence normal exit
	$ret;
}

sub start_cmd {
	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};
	push(@cmd, '-p') if $lei->{opt}->{prune};
	PublicInbox::Git::git_version() ge v2.29.0 and
		push(@cmd, '--no-write-fetch-head');
	@cmd;
}

sub upr { # feed `git update-ref --stdin -z' verbosely
	my ($lei, $w, $op, @rest) = @_; # ($ref, $oid) = @rest
	$lei->qerr("# $op @rest") if $lei->{opt}->{verbose};
	print $w "$op ", join("\0", @rest, '') or die "print(w): $!";
}

sub start_update_ref {
	my ($fgrp) = @_;
	pipe(my $r, my $w);
	my $cmd = [ 'git', "--git-dir=$fgrp->{cur_dst}",
		qw(update-ref --stdin -z) ];
	my $pack = PublicInbox::OnDestroy->new($$, \&satellite_done, $fgrp);
	start_cmd($fgrp, $cmd, { 0 => $r, 2 => $fgrp->{lei}->{2} }, $pack);
	close $r;
	$fgrp->{dry_run} ? undef : $w;
}

sub upref_warn { warn "E: close(update-ref --stdin): $! (need git 1.8.5+)\n" }

sub fgrp_update {
	my ($fgrp) = @_;
	return if !keep_going($fgrp);
	my $srcfh = delete $fgrp->{srcfh} or return;
	my $dstfh = delete $fgrp->{dstfh} or return;
	seek($srcfh, 0, SEEK_SET);
	seek($dstfh, 0, SEEK_SET);
	my %src = map { chomp; split /\0/ } PublicInbox::IO::read_all $srcfh;
	my %dst = map { chomp; split /\0/ } PublicInbox::IO::read_all $dstfh;
	$srcfh = $dstfh = undef;
	my $w = start_update_ref($fgrp) or return;
	my $lei = $fgrp->{lei};
	my $ndel;
	for my $ref (keys %dst) {
		my $new = delete $src{$ref};
		my $old = $dst{$ref};
		if (defined $new) {
			$new eq $old or
				upr($lei, $w, 'update', $ref, $new, $old);
		} else {
			upr($lei, $w, 'delete', $ref, $old);
			++$ndel;
		}
	}
	# git's ref files backend doesn't allow directory/file conflicts
	# between `delete' and `create' ops:
	if ($ndel && scalar(keys %src)) {
		$fgrp->{-create_refs} = \%src;
	} else {
		while (my ($ref, $oid) = each %src) {
			upr($lei, $w, 'create', $ref, $oid);
		}
	}
	$w->close or upref_warn();
}

sub satellite_done {
	my ($fgrp) = @_;
	if (my $create = delete $fgrp->{-create_refs}) {
		my $w = start_update_ref($fgrp) or return;
		while (my ($ref, $oid) = each %$create) {
			upr($fgrp->{lei}, $w, 'create', $ref, $oid);
		}
		$w->close or upref_warn();
	} else {
		pack_refs($fgrp, $fgrp->{cur_dst});
		run_puh($fgrp);
	}
}

sub pack_refs {
	my ($self, $git_dir) = @_;
	my $cmd = [ 'git', "--git-dir=$git_dir", qw(pack-refs --all --prune) ];
	start_cmd($self, $cmd, { 2 => $self->{lei}->{2} });
}

sub unlink_fetch_head ($) {
	my ($git_dir) = @_;
	return if CORE::unlink("$git_dir/FETCH_HEAD") || $!{ENOENT};
	warn "W: unlink($git_dir/FETCH_HEAD): $!";
}

sub fgrpv_done {
	my ($fgrpv) = @_;
	return if !$LIVE;
	my $first = $fgrpv->[0] // die 'BUG: no fgrpv->[0]';
	return if !keep_going($first);
	unlink_fetch_head($first->{-osdir}) if !$first->{dry_run};
	pack_refs($first, $first->{-osdir}); # objstore refs always packed
	for my $fgrp (@$fgrpv) {
		my $rn = $fgrp->{-remote};
		my %opt = ( 2 => $fgrp->{lei}->{2} );

		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/" ];
		open(my $sfh, '+>', undef);
		$fgrp->{srcfh} = $sfh;
		start_cmd($fgrp, $src, { %opt, 1 => $sfh }, $update_ref);
		my $dst = [ 'git', "--git-dir=$fgrp->{cur_dst}", 'for-each-ref',
			'--format=%(refname)%00%(objectname)' ];
		open(my $dfh, '+>', undef);
		$fgrp->{dstfh} = $dfh;
		start_cmd($fgrp, $dst, { %opt, 1 => $dfh }, $update_ref);
	}
}

sub fgrp_fetch_all {
	my ($self) = @_;
	my $todo = $FGRP_TODO;
	$FGRP_TODO = \'BUG on further use';
	keys(%$todo) or return;

	# Rely on the fgrptmp remote groups in the config file rather
	# than listing all remotes since the remote name list may exceed
	# system argv limits:
	my $grp = 'fgrptmp';

	my @git = (@{$self->{-torsocks}}, 'git');
	my $j = $self->{lei}->{opt}->{jobs};
	my $opt = {};
	my @fetch = do {
		local $self->{lei}->{opt}->{jobs} = 1;
		(fetch_args($self->{lei}, $opt), qw(--no-tags --multiple));
	};
	push(@fetch, "-j$j") if $j;
	while (my ($osdir, $fgrp_old_new) = each %$todo) {
		my $f = "$osdir/config";
		return if !keep_going($self);
		my ($old, $new) = @$fgrp_old_new;
		@$old = sort { $b->{-sort} <=> $a->{-sort} } @$old;
		# $new is ordered by {references}
		my $cmd = ['git', "--git-dir=$osdir", qw(config -f), $f ];

		# clobber settings from previous run atomically
		for ("remotes.$grp", 'fetch.hideRefs') {
			my $c = [ @$cmd, '--unset-all', $_ ];
			$self->{lei}->qerr("# @$c");
			next if $self->{dry_run};
			run_wait($c, undef, $opt);
			die "E: @$c \$?=$?" if ($? && ($? >> 8) != 5);
		}

		# permanent configs:
		my $cfg = PublicInbox::Config->git_config_dump($f);
		for my $fgrp (@$old, @$new) {
			my $u = $fgrp->{-uri} // die 'BUG: no {-uri}';
			my $rn = $fgrp->{-remote} // die 'BUG: no {-remote}';
			for ("url=$u", "fetch=+refs/*:refs/remotes/$rn/*",
					'tagopt=--no-tags') {
				my ($k, $v) = split(/=/, $_, 2);
				$k = "remote.$rn.$k";
				next if ($cfg->{$k} // '') eq $v;
				my $c = [@$cmd, $k, $v];
				$fgrp->{lei}->qerr("# @$c");
				next if $fgrp->{dry_run};
				run_die($c, undef, $opt);
			}
		}

		if (!$self->{dry_run}) {
			# update the config atomically via O_APPEND while
			# respecting git-config locking
			sysopen(my $lk, "$f.lock", O_CREAT|O_EXCL|O_WRONLY);
			open my $fh, '>>', $f;
			$fh->autoflush(1);
			my $buf = '';
			if (@$old) {
				$buf = "[fetch]\n\thideRefs = refs\n";
				$buf .= join('', map {
					"\thideRefs = !refs/remotes/" .
						"$_->{-remote}/\n";
				} @$old);
			}
			$buf .= join('', "[remotes]\n",
				(map { "\t$grp = $_->{-remote}\n" } @$old),
				(map { "\t$grp = $_->{-remote}\n" } @$new));
			print $fh $buf or die "print($f): $!";
			close $fh;
			unlink("$f.lock");
		}
		$cmd  = [ @git, "--git-dir=$osdir", @fetch, $grp ];
		push @$old, @$new;
		my $end = PublicInbox::OnDestroy->new($$, \&fgrpv_done, $old);
		start_cmd($self, $cmd, $opt, $end);
	}
}

# 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";
	if (!-d $dir && !$self->{dry_run}) {
		PublicInbox::Import::init_bare($dir);
		write_file '+>>', "$dir/config", <<EOM;
[repack]
	useDeltaIslands = true
[pack]
	island = refs/remotes/([^/]+)/
EOM
	}
	my $key = $self->{-key} // die 'BUG: no -key';
	my $rn = substr(sha256_hex($key), 0, 16);
	if (!-d $self->{cur_dst} && !$self->{dry_run}) {
		PublicInbox::Import::init_bare($self->{cur_dst});
		write_file '+>>', "$self->{cur_dst}/config", <<EOM;
; rely on the "$rn" remote in the
; $fg fork group for fetches
; only uncomment the following iff you detach from fork groups
; [remote "origin"]
;	url = $uri
;	fetch = +refs/*:refs/*
;	mirror = true
EOM
	}
	if (!$self->{dry_run}) {
		my $alt = File::Spec->rel2abs("$dir/objects");
		my $o = "$self->{cur_dst}/objects";
		my $l = File::Spec->abs2rel($alt, File::Spec->rel2abs($o));
		open my $fh, '+>>', my $f = "$o/info/alternates";
		seek($fh, 0, SEEK_SET); # Perl did SEEK_END when it saw '>>'
		my $seen = grep /\A\Q$l\E\n/, PublicInbox::IO::read_all $fh;
		print $fh "$l\n" if !$seen;
		close $fh;
	}
	bless {
		%$self, -osdir => $dir, -remote => $rn, -uri => $uri
	}, __PACKAGE__;
}

sub fp_done {
	my ($self, $cmd, $cb, @arg) = @_;
	if ($?) {
		$self->{lei}->err("@$cmd failed (\$?=$?) (non-fatal)");
		$? = 0; # don't let it influence normal exit
	}
	return if !keep_going($self);
	my $fh = delete $self->{-show_ref} // die 'BUG: no show-ref output';
	sysseek($fh, 0, SEEK_SET);
	$self->{-ent} // die 'BUG: no -ent';
	my $A = $self->{-ent}->{fingerprint} // die 'BUG: no fingerprint';
	my $B = sha_all(1, $fh)->hexdigest;
	return $cb->($self, @arg) if $A ne $B;
	$self->{lei}->qerr("# $self->{-key} up-to-date");
}

sub cmp_fp_do {
	my ($self, $cb, @arg) = @_;
	# $cb is either resume_fetch or fgrp_enqueue
	$self->{-ent} // return $cb->($self, @arg);
	my $new = $self->{-ent}->{fingerprint} // return $cb->($self, @arg);
	my $key = $self->{-key} // die 'BUG: no -key';
	if (my $cur_ent = $self->{-local_manifest}->{$key}) {
		# runs go_fetch->DESTROY run if eq
		return if $cur_ent->{fingerprint} eq $new;
	}
	my $dst = $self->{cur_dst} // $self->{dst};
	my $cmd = ['git', "--git-dir=$dst", 'show-ref'];
	my $opt = { 2 => $self->{lei}->{2} };
	open($opt->{1}, '+>', undef);
	$self->{-show_ref} = $opt->{1};
	do_reap($self);
	$self->{lei}->qerr("# @$cmd");
	$LIVE->{spawn($cmd, undef, $opt)} = [ \&fp_done, $self, $cmd,
						$cb, @arg ];
}

sub resume_fetch {
	my ($self, $uri, $fini) = @_;
	return if !keep_going($self);
	my $dst = $self->{cur_dst} // $self->{dst};
	my @git = ('git', "--git-dir=$dst");
	my $opt = { 2 => $self->{lei}->{2} };
	my $rn = 'random'.int(rand(1 << 30));
	for ("url=$uri", "fetch=+refs/*:refs/*", 'mirror=true') {
		push @git, '-c', "remote.$rn.$_";
	}
	my $cmd = [ @{$self->{-torsocks}}, @git,
			fetch_args($self->{lei}, $opt), $rn ];
	push @$cmd, '-P' if $self->{lei}->{prune}; # --prune-tags implied
	my $run_puh = PublicInbox::OnDestroy->new($$, \&run_puh, $self, $fini);
	++$self->{chg}->{nr_chg};
	start_cmd($self, $cmd, $opt, $run_puh);
}

sub fgrp_enqueue {
	my ($fgrp, $end) = @_; # $end calls fgrp_fetch_all
	return if !keep_going($fgrp);
	++$fgrp->{chg}->{nr_chg};
	my $dst = $FGRP_TODO->{$fgrp->{-osdir}} //= [ [], [] ]; # [ old, new ]
	push @{$dst->[defined($fgrp->{-sort} ? 0 : 1)]}, $fgrp;
}

sub clone_v1 {
	my ($self, $end) = @_;
	my $lei = $self->{lei};
	my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
	my $uri = URI->new($self->{cur_src} // $self->{src});
	my $path = $uri->path;
	$path =~ s!/*\z!! and $uri->path($path);
	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 $resume = -d $dst;
	if ($resume) { # respect read-only cloned w/ --epoch=
		my @st = stat(_); # for root
		if (!-w _ || !($st[2] & 0222)) {
			warn "# skipping $dst, not writable\n";
			return;
		}
	}
	my $fini = PublicInbox::OnDestroy->new($$, \&v1_done, $self);
	if (my $fgrp = forkgroup_prep($self, $uri)) {
		$fgrp->{-fini} = $fini;
		if ($resume) {
			$fgrp->{-sort} = $fgrp->{-ent}->{modified};
			cmp_fp_do($fgrp, \&fgrp_enqueue, $end);
		} else { # new repo, save for last
			fgrp_enqueue($fgrp, $end);
		}
	} elsif ($resume) {
		cmp_fp_do($self, \&resume_fetch, $uri, $fini);
	} else { # normal clone
		my $cmd = [ @{$self->{-torsocks}},
				clone_cmd($lei, my $opt = {}), "$uri", $dst ];
		if (defined($self->{-ent})) {
			if (defined(my $ref = $self->{-ent}->{reference})) {
				-e "$self->{dst}$ref" and
					push @$cmd, '--reference',
						"$self->{dst}$ref";
			}
		}
		++$self->{chg}->{nr_chg};
		start_cmd($self, $cmd, $opt, PublicInbox::OnDestroy->new($$,
						\&run_puh, $self, $fini));
	}
	if (!$self->{-is_epoch} && $lei->{opt}->{'inbox-config'} =~
				/\A(?:always|v1)\z/s &&
			!-f "$dst/inbox.config.example") {
		_get_txt_start($self, '_/text/config/raw', $fini);
	}

	my $d = $self->{-ent} ? $self->{-ent}->{description} : undef;
	utf8::encode($self->{'txt.description'} = $d) if defined $d;
	(!defined($d) && !$end) and
		_get_txt_start($self, 'description', $fini);

	$end 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 @owner = defined($ent->{owner}) ? (<<EOM) : ();
[gitweb]
	owner = $ent->{owner}
EOM
	write_file '>>', "$edst/config", <<EOM, @owner;
[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
	my %map = (head => 'HEAD', description => undef);
	while (my ($key, $fn) = each %map) {
		my $val = $ent->{$key} // next;
		$fn //= $key;
		write_file '>', "$edst/$fn", $val;
	}
}

sub reap_cmd { # async, called via SIGCHLD
	my ($self, $cmd) = @_;
	my $cerr = $?;
	$? = 0; # don't let it influence normal exit
	$self->{lei}->child_error($cerr, "@$cmd failed (\$?=$cerr)") if $cerr;
}

sub up_fp_done {
	my ($self) = @_;
	return if !keep_going($self);
	my $fh = delete $self->{-show_ref_up} // die 'BUG: no show-ref output';
	sysseek($fh, 0, SEEK_SET);
	$self->{-ent} // die 'BUG: no -ent';
	my $A = $self->{-ent}->{fingerprint} // die 'BUG: no fingerprint';
	my $B = sha_all(1, $fh)->hexdigest;
	return if $A eq $B;
	$self->{-ent}->{fingerprint} = $B;
	push @{$self->{chg}->{fp_mismatch}}, $self->{-key};
}

sub atomic_write ($$$) {
	my ($dn, $bn, $raw) = @_;
	my $ft = File::Temp->new(DIR => $dn, TEMPLATE => "$bn-XXXX");
	print $ft $raw;
	$ft->flush or die "flush($ft): $!";
	ft_rename($ft, "$dn/$bn", 0666);
}

sub run_next_puh {
	my ($self) = @_;
	my $puh = shift @{$self->{-puh_todo}} // return delete($self->{-fini});
	my $fini = PublicInbox::OnDestroy->new($$, \&run_next_puh, $self);
	my $cmd = [ @$puh, ($self->{cur_dst} // $self->{dst}) ];
	my $opt = +{ map { $_ => $self->{lei}->{$_} } (0..2) };
	start_cmd($self, $cmd, undef, $opt, $fini);
}

sub run_puh {
	my ($self, $fini) = @_;
	$self->{-fini} = $fini;
	@{$self->{-puh_todo}} = @PUH;
	run_next_puh($self);
}

# modifies the to-be-written manifest entry, and sets values from it, too
sub update_ent {
	my ($self) = @_;
	my $key = $self->{-key} // die 'BUG: no -key';
	my $new = $self->{-ent}->{fingerprint};
	my $cur = $self->{-local_manifest}->{$key}->{fingerprint} // "\0";
	my $dst = $self->{cur_dst} // $self->{dst};
	if (defined($new) && $new ne $cur) {
		my $cmd = ['git', "--git-dir=$dst", 'show-ref'];
		my $opt = { 2 => $self->{lei}->{2} };
		open($opt->{1}, '+>', undef);
		$self->{-show_ref_up} = $opt->{1};
		my $done = PublicInbox::OnDestroy->new($$, \&up_fp_done, $self);
		start_cmd($self, $cmd, $opt, $done);
	}
	$new = $self->{-ent}->{head};
	$cur = $self->{-local_manifest}->{$key}->{head} // "\0";
	if (defined($new) && $new ne $cur) {
		# n.b. grokmirror writes raw contents to $dst/HEAD w/o locking
		my $cmd = [ 'git', "--git-dir=$dst" ];
		if ($new =~ s/\Aref: //) {
			push @$cmd, qw(symbolic-ref HEAD), $new;
		} elsif ($new =~ /\A[a-f0-9]{40,}\z/) {
			push @$cmd, qw(update-ref --no-deref HEAD), $new;
		} else {
			undef $cmd;
			warn "W: $key: {head} => `$new' not understood\n";
		}
		start_cmd($self, $cmd, { 2 => $self->{lei}->{2} }) if $cmd;
	}
	if (my $symlinks = $self->{-ent}->{symlinks}) {
		my $top = File::Spec->rel2abs($self->{dst});
		push @{$self->{-new_symlinks}}, @$symlinks;
		for my $p (@$symlinks) {
			my $ln = "$top/$p";
			$ln =~ tr!/!/!s;
			my (undef, $dn, $bn) = File::Spec->splitpath($ln);
			File::Path::mkpath($dn);
			my $tgt = "$top/$key";
			$tgt = File::Spec->abs2rel($tgt, $dn);
			if (lstat($ln)) {
				if (-l _) {
					next if readlink($ln) eq $tgt;
					unlink($ln);
				} else {
					push @{$self->{chg}->{badlink}}, $p;
				}
			}
			symlink($tgt, $ln);
			++$self->{chg}->{nr_chg};
		}
	}
	if (defined(my $t = $self->{-ent}->{modified})) {
		my ($dn, $bn) = ("$dst/info/web", 'last-modified');
		my $orig = PublicInbox::IO::try_cat("$dn/$bn");
		$t = strftime('%F %T', gmtime($t))." +0000\n";
		File::Path::mkpath($dn);
		atomic_write($dn, $bn, $t) if $orig ne $t;
	}

	$new = $self->{-ent}->{owner} // return;
	$cur = $self->{-local_manifest}->{$key}->{owner} // "\0";
	return if $cur eq $new;
	utf8::encode($new); # to octets
	my $cmd = [ qw(git config -f), "$dst/config", 'gitweb.owner', $new ];
	start_cmd($self, $cmd, { 2 => $self->{lei}->{2} });
}

sub v1_done { # called via OnDestroy
	my ($self) = @_;
	return if $self->{dry_run} || !keep_going($self);
	_write_inbox_config($self);
	my $dst = $self->{cur_dst} // $self->{dst};
	unlink_fetch_head($dst);
	update_ent($self) if $self->{-ent};
	my $o = "$dst/objects";
	if (CORE::open(my $fh, '<', my $fn = "$o/info/alternates")) {;
		my $base = File::Spec->rel2abs($o);
		my @l = <$fh>;
		my $ft;
		for (@l) {
			next unless m!\A/!;
			$_ = File::Spec->abs2rel($_, $base);
			$ft //= File::Temp->new(TEMPLATE => '.XXXX',
						DIR => "$o/info");
		}
		if ($ft) {
			print $ft @l;
			$ft->flush or die "flush($ft): $!";
			ft_rename($ft, $fn, 0666, $fh);
		}
	}
	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 v2_done { # called via OnDestroy
	my ($self) = @_;
	return if $self->{dry_run} || !keep_going($self);
	my $dst = $self->{cur_dst} // $self->{dst};
	require PublicInbox::Lock;
	my $lk = PublicInbox::Lock->new("$dst/inbox.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);
	}
	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 $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;
	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

		$1 + 0 == $nr or die "BUG: <$uri> miskeyed $1 != $nr";
		$edst .= "/git/$nr.git";
		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 @{$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;
		}
	}
	# filter out the epochs we skipped
	$self->{chg}->{manifest} = 1 if $m && delete(@$m{@skip});

	$self->{dry_run} or File::Path::mkpath($dst);

	if ($lei->{opt}->{'inbox-config'} =~ /\A(?:always|v2)\z/s &&
			!-f "$dst/inbox.config.example") {
		_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 = PublicInbox::IO::read_all $fh;
	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 load_current_manifest ($) {
	my ($self) = @_;
	my $fn = $self->{-manifest} // return;
	if (CORE::open(my $fh, '<', $fn)) {
		decode_manifest($fh, $fn, $fn);
	} elsif ($!{ENOENT}) { # non-fatal, we can just do it slowly
		$self->{-initial_clone} or
			warn "W: open($fn): $! (non-fatal)\n";
		undef;
	} else {
		die "E: open($fn): $!\n";
	}
}

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 {
				glob2re($_) // qr/\A\Q$_\E/
			} @$incl).'\\z)';
		my @gone = delete @$v2{grep(!/$re/, keys %$v2)};
		delete @$m{map { @$_ } @gone} and $self->{chg}->{manifest} = 1;
		delete @$m{grep(!/$re/, @v1)} and $self->{chg}->{manifest} = 1;
		@v1 = grep(/$re/, @v1);
	}
	if (defined $excl) {
		my $re = '(?:'.join('\\z|', map {
				glob2re($_) // qr/\A\Q$_\E/
			} @$excl).'\\z)';
		my @gone = delete @$v2{grep(/$re/, keys %$v2)};
		delete @$m{map { @$_ } @gone} and $self->{chg}->{manifest} = 1;
		delete @$m{grep(/$re/, @v1)} and $self->{chg}->{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 = $TODO;
	$TODO = \'BUG on further use';
	my $end = PublicInbox::OnDestroy->new($$, \&fgrp_fetch_all, $self);
	{
		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($_, $end);
			return if !keep_going($self);
		}
	}
	# 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;
				if (++$nr > 1000) {
					$m->{$x}->{reference} = undef;
					$m->{$nxt}->{reference} = undef;
					warn <<EOM
E: dependency loop detected (`$x' => `$nxt'), breaking
EOM
				}
				$x = $nxt;
			}
			my $y = delete $todo->{$x} // next; # already done
			for (@$y) {
				clone_v1($_, $end);
				return if !keep_going($self);
			}
			last; # restart %$todo iteration
		}
	}

	# $end->DESTROY will call fgrp_fetch_all once all references
	# in $LIVE are gone, and do_reap will eventually drain $LIVE
	$end = undef;
	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, 0, SEEK_SET);
	truncate($ft, 0);
	gzip(\$json => $ft) or die "gzip($ft): $GzipError";
	$ft->flush or die "flush($ft): $!";
	utime($mtime, $mtime, "$ft") or die "utime(..., $ft): $!";
}

sub dump_project_list ($$) {
	my ($self, $m) = @_;
	my $f = $self->{'-project-list'};
	my $old = defined($f) ? PublicInbox::IO::try_cat($f) : '';
	my %new;

	open my $dh, '<', '.';
	if (!$self->{dry_run} || -d $self->{dst}) {
		chdir($self->{dst});
	}
	my @local = grep { -e $_ ? ($new{$_} = undef) : 1 } split(/\n/s, $old);
	chdir($dh);

	$new{substr($_, 1)} = 1 for keys %$m; # drop leading '/'
	my @list = sort keys %new;
	my @remote = grep { !defined($new{$_}) } @list;
	my %lnk = map { substr($_, 1) => undef } @{$self->{-new_symlinks}};
	@remote = grep { !exists($lnk{$_}) } @remote;

	if (@remote) {
		warn <<EOM;
The following local repositories are ignored/gone from $self->{src}:
EOM
		warn "\t", $_, "\n" for @remote;

		if ($self->{lei}->{opt}->{purge} && !$self->{dry_run}) {
			my $o = {};
			$o->{verbose} = 1 if $self->{lei}->{opt}->{verbose};
			my $dst = $self->{dst};
			File::Path::remove_tree(map { "$dst/$_" } @remote, $o);
			my %rm = map { $_ => undef } @remote;
			@list = grep { !exists($rm{$_}) } @list;
			$self->{lei}->qerr('# purged ');
		}
	}
	if (defined($f) && @local) {
		warn <<EOM;
The following repos in $f no longer exist on the filesystem:
EOM
		warn "\t", $_, "\n" for @local;
	}
	$self->{chg}->{nr_chg} += scalar(@remote) + scalar(@local);
	return if !defined($f) || $self->{dry_run};
	my (undef, $dn, $bn) = File::Spec->splitpath($f);
	my $new = join("\n", @list, '');
	atomic_write($dn, $bn, $new) if $new ne $old;
}

# 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 $lei = $self->{lei};
	my $curl = $self->{curl} //= PublicInbox::LeiCurl->new($lei) or return;
	$self->{-torsocks} //= $curl->torsocks($lei, $uri) or return;
	my $path = $uri->path;
	chop($path) eq '/' or die "BUG: $uri not canonicalized";
	my $rmf = $lei->{opt}->{'remote-manifest'} // '/manifest.js.gz';
	if ($rmf =~ m!\A[^/:]+://!) {
		$uri = URI->new($rmf);
	} else {
		$rmf = "/$rmf" if index($rmf, '/') != 0;
		$uri->path($path.$rmf);
	}
	my $manifest = $self->{-manifest} // "$self->{dst}/manifest.js.gz";
	my %opt = (UNLINK => 1, SUFFIX => '.tmp', TMPDIR => 1);
	if (!$self->{dry_run} && $manifest =~ m!\A(.+?)/[^/]+\z! and -d $1) {
		$opt{DIR} = $1; # allows fast rename(2) w/o EXDEV
		delete $opt{TMPDIR};
	}
	my $ft = File::Temp->new(TEMPLATE => '.manifest-XXXX', %opt);
	my $cmd = $curl->for_uri($lei, $uri, qw(-R -o), $ft->filename);
	push(@$cmd, '-z', $manifest) if -f $manifest;
	my $mf_url = "$uri";
	%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");
	}

	# bail out if curl -z/--timecond hit 304 Not Modified, $ft will be empty
	if (-f $manifest && !-s $ft) {
		$lei->child_error(127 << 8) if $lei->{opt}->{'exit-code'};
		return $lei->qerr("# $manifest unchanged");
	}

	my $m = eval { decode_manifest($ft, $ft, $uri) };
	if ($@) {
		warn $@;
		return try_scrape($self);
	}
	local $self->{chg} = {};
	local $self->{-local_manifest} = load_current_manifest($self);
	local $self->{-new_symlinks} = [];
	my ($path_pfx, $n, $multi) = multi_inbox($self, \$path, $m);
	return $lei->child_error(0, $multi) if !ref($multi);
	my $v2 = delete $multi->{v2};
	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
			clone_v2_prep($self, \%v2_epochs, $m);
			return if !keep_going($self);
		}
	}
	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 @{$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 !keep_going($self);

	# set by clone_v2_prep/-I/--exclude
	my $mis = delete $self->{chg}->{fp_mismatch};
	if ($mis) {
		my $t = fmt_localtime((stat($ft))[9]);
		warn <<EOM;
W: Fingerprints for the following repositories do not match
W: $mf_url @ $t:
W: These repositories may have updated since $t:
EOM
		warn "\t", $_, "\n" for @$mis;
		warn <<EOM if !$self->{lei}->{opt}->{prune};
W: The above fingerprints may never match without --prune
EOM
	}
	if ((delete($self->{chg}->{manifest}) || $mis) && !$self->{dry_run}) {
		dump_manifest($m => $ft);
	}
	my $bad = delete $self->{chg}->{badlink};
	warn(<<EOM, map { ("\t", $_, "\n") } @$bad) if $bad;
W: The following exist and have not been converted to symlinks
EOM
	dump_project_list($self, $m);
	ft_rename($ft, $manifest, 0666) if !$self->{dry_run};
	!$self->{chg}->{nr_chg} && $lei->{opt}->{'exit-code'} and
		$lei->child_error(127 << 8);
}

sub start_clone_url {
	my ($self) = @_;
	return try_manifest($self) if $self->{src} =~ m!\Ahttps?://!;
	die "TODO: non-HTTP/HTTPS clone of $self->{src} not supported, yet";
}

sub do_mirror { # via wq_io_do or public-inbox-clone
	my ($self) = @_;
	my $lei = $self->{lei};
	$self->{dry_run} = 1 if $lei->{opt}->{'dry-run'};
	umask($lei->{client_umask}) if defined $lei->{client_umask};
	$self->{-initial_clone} = 1 if !-d $self->{dst};
	local @PUH;
	if (defined(my $puh = $lei->{opt}->{'post-update-hook'})) {
		require Text::ParseWords;
		@PUH = map { [ Text::ParseWords::shellwords($_) ] } @$puh;
	}
	eval {
		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'

		# we support these switches with '' (empty string).
		# defaults match example conf distributed with grokmirror
		my @pairs = qw(objstore objstore manifest manifest.js.gz
				project-list projects.list);
		while (@pairs) {
			my ($k, $default) = splice(@pairs, 0, 2);
			my $v = $lei->{opt}->{$k} // next;
			$v = $default if $v eq '';
			$v = "$self->{dst}/$v" if $v !~ m!\A\.{0,2}/!;
			$self->{"-$k"} = $v;
		}

		local $LIVE = {};
		local $TODO = {};
		local $FGRP_TODO = {};
		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;
	$lei->request_umask;
	my ($op_c, $ops) = $lei->workers_start($self, 1);
	$lei->{wq1} = $self;
	$self->wq_io_do('do_mirror', []);
	$self->wq_close;
	$lei->wait_wq_events($op_c, $ops);
}

sub ipc_atfork_child {
	my ($self) = @_;
	$self->{lei}->_lei_atfork_child;
	$self->SUPER::ipc_atfork_child;
}

sub write_makefile {
	my ($dir, $ibx_ver) = @_;
	my $f = "$dir/Makefile";
	if (CORE::sysopen my $fh, $f, O_CREAT|O_EXCL|O_WRONLY) {
		print $fh <<EOM;
# 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';
# 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;
	} else {
		die "open($f): $!" unless $!{EEXIST};
	}
}

1;

git clone https://public-inbox.org/public-inbox.git
git clone http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/public-inbox.git