X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=script%2Fpublic-inbox-init;h=5de4578158fb19412ade85ae534cab27fba1d4e6;hp=ca0f9ddfa8fe0de98a6ec0498b6477d348553cdb;hb=refs%2Fheads%2Fmaster;hpb=f850effe0baef8a37ad2eef3ef581b79539cc304 diff --git a/script/public-inbox-init b/script/public-inbox-init index ca0f9ddf..5de45781 100755 --- a/script/public-inbox-init +++ b/script/public-inbox-init @@ -1,38 +1,136 @@ -#!/usr/bin/perl -w -# Copyright (C) 2014-2015 all contributors -# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) -# -# Initializes a public-inbox, basically a wrapper for git-init(1) +#!perl -w +# Copyright (C) 2014-2021 all contributors +# License: AGPL-3.0+ use strict; -use warnings; -my $usage = "public-inbox-init NAME GIT_DIR HTTP_URL ADDRESS [ADDRESS..]"; -use PublicInbox::Config; -use File::Temp qw/tempfile/; -use File::Basename qw/dirname/; -use File::Path qw/mkpath/; -use Cwd qw/abs_path/; - -sub x { system(@_) and die join(' ', @_). " failed: $?\n" } -sub usage { print STDERR "Usage: $usage\n"; exit 1 } - -my $name = shift @ARGV or usage(); -my $git_dir = shift @ARGV or usage(); -my $http_url = shift @ARGV or usage(); +use v5.10.1; +use Getopt::Long qw/:config gnu_getopt no_ignore_case auto_abbrev/; +use Fcntl qw(:DEFAULT); +my $help = < \$version, + 'L|index-level|indexlevel=s' => \$indexlevel, + 'S|skip|skip-epoch=i' => \$skip_epoch, + 'skip-artnum=i' => \$skip_artnum, + 'j|jobs=i' => \$jobs, + 'ng|newsgroup=s' => \$ng, + 'skip-docdata' => \$skip_docdata, + 'help|h' => \$show_help, + 'c=s@' => \@c_extra, + 'C=s@' => \@chdir, +); +my $usage_cb = sub { + print STDERR $help; + exit 1; +}; +GetOptions(%opts) or $usage_cb->(); +if ($show_help) { print $help; exit 0 }; +my $name = shift @ARGV or $usage_cb->(); +my $inboxdir = shift @ARGV or $usage_cb->(); +my $http_url = shift @ARGV or $usage_cb->(); my (@address) = @ARGV; -@address or usage(); -my %seen; +@address or $usage_cb->(); ++PublicInbox::Admin::do_chdir(\@chdir); + +@c_extra = map { + my ($k, $v) = split(/=/, $_, 2); + defined($v) or die "Usage: -c KEY=VALUE\n"; + $k =~ /\A[a-z]+\z/i or die "$k contains invalid characters\n"; + $k = lc($k); + if ($k eq 'newsgroup') { + die "newsgroup already set ($ng)\n" if $ng ne ''; + $ng = $v; + (); + } elsif ($k eq 'address') { + push @address, $v; # for conflict checking + (); + } elsif ($k =~ /\A(?:inboxdir|mainrepo)\z/) { + die "$k not allowed via -c $_\n" + } elsif ($k eq 'indexlevel') { + defined($indexlevel) and + die "indexlevel already set ($indexlevel)\n"; + $indexlevel = $v; + (); + } else { + $_ + } +} @c_extra; + +PublicInbox::Admin::indexlevel_ok_or_die($indexlevel) if defined $indexlevel; +$ng =~ m![^A-Za-z0-9/_\.\-\~\@\+\=:]! and + die "--newsgroup `$ng' is not valid\n"; +($ng =~ m!\A\.! || $ng =~ m!\.\z!) and + die "--newsgroup `$ng' must not start or end with `.'\n"; + +require PublicInbox::Config; my $pi_config = PublicInbox::Config->default_file; -my $dir = dirname($pi_config); -mkpath($dir); # will croak on fatal errors -my ($fh, $filename) = tempfile('pi-init-XXXXXXXX', DIR => $dir); +my ($dir) = ($pi_config =~ m!(.*?/)[^/]+\z!); +require File::Path; +File::Path::mkpath($dir); # will croak on fatal errors + +# first, we grab a flock to prevent simultaneous public-inbox-init +# processes from trampling over each other, or exiting with 255 on +# O_EXCL failure below. This gets unlocked automatically on exit: +require PublicInbox::Lock; +my $lock_obj = { lock_path => "$pi_config.flock" }; +PublicInbox::Lock::lock_acquire($lock_obj); + +# git-config will operate on this (and rename on success): +require File::Temp; +my $fh = File::Temp->new(TEMPLATE => 'pi-init-XXXX', DIR => $dir); + +# Now, we grab another lock to use git-config(1) locking, so it won't +# wait on the lock, unlike some of our internal flock()-based locks. +# This is to prevent direct git-config(1) usage from clobbering our +# changes. +my $lockfile = "$pi_config.lock"; +my $lockfh; +sysopen($lockfh, $lockfile, O_RDWR|O_CREAT|O_EXCL) or do { + warn "could not open config file: $lockfile: $!\n"; + exit(255); +}; +require PublicInbox::OnDestroy; +my $auto_unlink = PublicInbox::OnDestroy->new($$, sub { unlink $lockfile }); +my ($perm, %seen); if (-e $pi_config) { open(my $oh, '<', $pi_config) or die "unable to read $pi_config: $!\n"; - my $old; - { - local $/; - $old = <$oh>; - } + my @st = stat($oh); + $perm = $st[2]; + defined $perm or die "(f)stat failed on $pi_config: $!\n"; + chmod($perm & 07777, $fh) or + die "(f)chmod failed on future $pi_config: $!\n"; + defined(my $old = do { local $/; <$oh> }) or die "read $pi_config: $!\n"; print $fh $old or die "failed to write: $!\n"; close $oh or die "failed to close $pi_config: $!\n"; @@ -43,10 +141,10 @@ if (-e $pi_config) { foreach my $addr (@address) { my $found = $cfg->lookup($addr); if ($found) { - if ($found->{inbox} ne $name) { + if ($found->{name} ne $name) { print STDERR "`$addr' already defined for ", - "`$found->{inbox}',\n", + "`$found->{name}',\n", "does not match intend `$name'\n"; $conflict = 1; } else { @@ -56,19 +154,103 @@ if (-e $pi_config) { } exit(1) if $conflict; + + my $ibx = $cfg->lookup_name($name); + $indexlevel //= $ibx->{indexlevel} if $ibx; } -close $fh or die "failed to close $filename: $!\n"; +my $pi_config_tmp = $fh->filename; +close($fh) or die "failed to close $pi_config_tmp: $!\n"; my $pfx = "publicinbox.$name"; -my @x = (qw/git config/, "--file=$filename"); -$git_dir = abs_path($git_dir); -x(qw(git init -q --bare), $git_dir); +my @x = (qw/git config/, "--file=$pi_config_tmp"); + +$inboxdir = PublicInbox::Config::rel2abs_collapsed($inboxdir); +die "`\\n' not allowed in `$inboxdir'\n" if index($inboxdir, "\n") >= 0; + +if (-f "$inboxdir/inbox.lock") { + if (!defined $version) { + $version = 2; + } elsif ($version != 2) { + die "$inboxdir is a -V2 inbox, -V$version specified\n" + } +} elsif (-d "$inboxdir/objects") { + if (!defined $version) { + $version = 1; + } elsif ($version != 1) { + die "$inboxdir is a -V1 inbox, -V$version specified\n" + } +} + +$version = 1 unless defined $version; + +if ($version == 1 && defined $skip_epoch) { + die "--skip-epoch is only supported for -V2 inboxes\n"; +} + +my $ibx = PublicInbox::Inbox->new({ + inboxdir => $inboxdir, + name => $name, + version => $version, + -primary_address => $address[0], + indexlevel => $indexlevel, +}); + +my $creat_opt = {}; +if (defined $jobs) { + die "--jobs is only supported for -V2 inboxes\n" if $version == 1; + die "--jobs=$jobs must be >= 1\n" if $jobs <= 0; + $creat_opt->{nproc} = $jobs; +} + +require PublicInbox::InboxWritable; +$ibx = PublicInbox::InboxWritable->new($ibx, $creat_opt); +if ($skip_docdata) { + $ibx->{indexlevel} //= 'full'; # ensure init_inbox writes xdb + $ibx->{indexlevel} eq 'basic' and + die "--skip-docdata ignored with --indexlevel=basic\n"; + $ibx->{-skip_docdata} = $skip_docdata; +} +$ibx->init_inbox(0, $skip_epoch, $skip_artnum); + +my $f = "$inboxdir/description"; +if (sysopen $fh, $f, O_CREAT|O_EXCL|O_WRONLY) { + print $fh "public inbox for $address[0]\n" or die "print($f): $!"; + close $fh or die "close($f): $!"; +} + +# needed for git prior to v2.1.0 +umask(0077) if defined $perm; + +require PublicInbox::Spawn; +PublicInbox::Spawn->import(qw(run_die)); + foreach my $addr (@address) { next if $seen{lc($addr)}; - x(@x, "--add", "$pfx.address", $addr); + run_die([@x, "--add", "$pfx.address", $addr]); +} +run_die([@x, "$pfx.url", $http_url]); +run_die([@x, "$pfx.inboxdir", $inboxdir]); + +if (defined($indexlevel)) { + run_die([@x, "$pfx.indexlevel", $indexlevel]); +} +run_die([@x, "$pfx.newsgroup", $ng]) if $ng ne ''; + +for my $kv (@c_extra) { + my ($k, $v) = split(/=/, $kv, 2); + # git 2.30+ has --fixed-value for idempotent invocations, + # but that's too new to depend on in 2021. Perl quotemeta + # seems compatible enough for POSIX ERE which git uses + my $re = '^'.quotemeta($v).'$'; + run_die([@x, qw(--replace-all), "$pfx.$k", $v, $re]); +} + +# needed for git prior to v2.1.0 +if (defined $perm) { + chmod($perm & 07777, $pi_config_tmp) or + die "(f)chmod failed on future $pi_config: $!\n"; } -x(@x, "$pfx.url", $http_url); -x(@x, "$pfx.mainrepo", $git_dir); -rename $filename, $pi_config or - die "failed to rename `$filename' to `$pi_config': $!\n"; +rename $pi_config_tmp, $pi_config or + die "failed to rename `$pi_config_tmp' to `$pi_config': $!\n"; +undef $auto_unlink; # trigger ->DESTROY