X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FConfig.pm;h=f2e5d5f0801e4c0f566f51ae654bdc55a5112c38;hb=1d6ebab439828dce8b7e8cbb99dfbc237e9d5a74;hp=577337dc8a024d375be2db4f72cffb0365be2ffb;hpb=3e9888ed30b7fe092b03789d19a8020d4bc0fb39;p=public-inbox.git diff --git a/lib/PublicInbox/Config.pm b/lib/PublicInbox/Config.pm index 577337dc..f2e5d5f0 100644 --- a/lib/PublicInbox/Config.pm +++ b/lib/PublicInbox/Config.pm @@ -1,4 +1,4 @@ -# Copyright (C) 2014-2020 all contributors +# Copyright (C) 2014-2021 all contributors # License: AGPL-3.0+ # # Used throughout the project for reading configuration @@ -12,22 +12,24 @@ use strict; use v5.10.1; use PublicInbox::Inbox; use PublicInbox::Spawn qw(popen_rd); +our $LD_PRELOAD = $ENV{LD_PRELOAD}; # only valid at startup sub _array ($) { ref($_[0]) eq 'ARRAY' ? $_[0] : [ $_[0] ] } # returns key-value pairs of config directives in a hash # if keys may be multi-value, the value is an array ref containing all values sub new { - my ($class, $file) = @_; + my ($class, $file, $errfh) = @_; $file //= default_file(); my $self; if (ref($file) eq 'SCALAR') { # used by some tests open my $fh, '<', $file or die; # PerlIO::scalar $self = config_fh_parse($fh, "\n", '='); + bless $self, $class; } else { - $self = git_config_dump($file); + $self = git_config_dump($class, $file, $errfh); + $self->{'-f'} = $file; } - bless $self, $class; # caches $self->{-by_addr} = {}; $self->{-by_list_id} = {}; @@ -87,12 +89,17 @@ sub lookup_list_id { sub lookup_name ($$) { my ($self, $name) = @_; - $self->{-by_name}->{$name} // _fill($self, "publicinbox.$name"); + $self->{-by_name}->{$name} // _fill_ibx($self, $name); } sub lookup_ei { my ($self, $name) = @_; - $self->{-ei_by_name}->{$name} //= _fill_ei($self, "extindex.$name"); + $self->{-ei_by_name}->{$name} //= _fill_ei($self, $name); +} + +sub lookup_eidx_key { + my ($self, $eidx_key) = @_; + _lookup_fill($self, '-by_eidx_key', $eidx_key); } # special case for [extindex "all"] @@ -132,20 +139,16 @@ sub default_file { sub config_fh_parse ($$$) { my ($fh, $rs, $fs) = @_; - my %rv; - my (%section_seen, @section_order); + my (%rv, %seen, @section_order, $line, $k, $v, $section, $cur, $i); local $/ = $rs; - while (defined(my $line = <$fh>)) { - chomp $line; - my ($k, $v) = split($fs, $line, 2); - my ($section) = ($k =~ /\A(\S+)\.[^\.]+\z/); - unless (defined $section_seen{$section}) { - $section_seen{$section} = 1; - push @section_order, $section; - } - - my $cur = $rv{$k}; - if (defined $cur) { + while (defined($line = <$fh>)) { # perf critical with giant configs + $i = index($line, $fs); + $k = substr($line, 0, $i); + $v = substr($line, $i + 1, -1); # chop off $fs + $section = substr($k, 0, rindex($k, '.')); + $seen{$section} //= push(@section_order, $section); + + if (defined($cur = $rv{$k})) { if (ref($cur) eq "ARRAY") { push @$cur, $v; } else { @@ -161,17 +164,17 @@ sub config_fh_parse ($$$) { } sub git_config_dump { - my ($file) = @_; - return {} unless -e $file; + my ($class, $file, $errfh) = @_; + return bless {}, $class unless -e $file; my $cmd = [ qw(git config -z -l --includes), "--file=$file" ]; - my $fh = popen_rd($cmd); + my $fh = popen_rd($cmd, undef, { 2 => $errfh // 2 }); my $rv = config_fh_parse($fh, "\0", "\n"); - close $fh or die "failed to close (@$cmd) pipe: $?"; - $rv; + close $fh or die "@$cmd failed: \$?=$?\n"; + bless $rv, $class; } -sub valid_inbox_name ($) { - my ($name) = @_; +sub valid_foo_name ($;$) { + my ($name, $pfx) = @_; # Similar rules found in git.git/remote.c::valid_remote_nick # and git.git/refs.c::check_refname_component @@ -179,6 +182,7 @@ sub valid_inbox_name ($) { if ($name eq '' || $name =~ /\@\{/ || $name =~ /\.\./ || $name =~ m![/:\?\[\]\^~\s\f[:cntrl:]\*]! || $name =~ /\A\./ || $name =~ /\.\z/) { + warn "invalid $pfx name: `$name'\n" if $pfx; return 0; } @@ -324,39 +328,25 @@ sub parse_cgitrc { sub _fill_code_repo { my ($self, $nick) = @_; my $pfx = "coderepo.$nick"; - - # TODO: support gitweb and other repository viewers? - if (defined(my $cgitrc = delete $self->{-cgitrc_unparsed})) { - parse_cgitrc($self, $cgitrc, 0); - } - my $dir = $self->{"$pfx.dir"}; # aka "GIT_DIR" - unless (defined $dir) { + my $dir = $self->{"$pfx.dir"} // do { # aka "GIT_DIR" warn "$pfx.dir unset\n"; return; - } - + }; my $git = PublicInbox::Git->new($dir); - foreach my $t (qw(blob commit tree tag)) { - $git->{$t.'_url_format'} = - _array($self->{lc("$pfx.${t}UrlFormat")}); - } - if (defined(my $cgits = $self->{"$pfx.cgiturl"})) { $git->{cgit_url} = $cgits = _array($cgits); $self->{"$pfx.cgiturl"} = $cgits; - - # cgit supports "/blob/?id=%s", but it's only a plain-text - # display and requires an unabbreviated id= - foreach my $t (qw(blob commit tag)) { - $git->{$t.'_url_format'} //= map { - "$_/$t/?id=%s" - } @$cgits; - } } $git; } +sub get_all { + my ($self, $key) = @_; + my $v = $self->{$key} // return; + _array($v); +} + sub git_bool { my ($val) = $_[-1]; # $_[0] may be $self, or $val if ($val =~ /\A(?:false|no|off|[\-\+]?(?:0x)?0+)\z/i) { @@ -378,26 +368,54 @@ sub rel2abs_collapsed { Cwd::abs_path($p); } -sub _fill { - my ($self, $pfx) = @_; - my $ibx = {}; +sub get_1 { + my ($self, $key) = @_; + my $v = $self->{$key}; + return $v if !ref($v); + warn "W: $key has multiple values, only using `$v->[-1]'\n"; + $v->[-1]; +} - for my $k (qw(watch nntpserver)) { +sub repo_objs { + my ($self, $ibxish) = @_; + my $ibx_code_repos = $ibxish->{coderepo} or return; + $ibxish->{-repo_objs} //= do { + my $code_repos = $self->{-code_repos}; + my @repo_objs; + for my $nick (@$ibx_code_repos) { + my @parts = split(m!/!, $nick); + for (@parts) { + @parts = () unless valid_foo_name($_); + } + unless (@parts) { + warn "invalid coderepo name: `$nick'\n"; + next; + } + my $repo = $code_repos->{$nick} //= + _fill_code_repo($self, $nick); + push @repo_objs, $repo if $repo; + } + if (scalar @repo_objs) { + \@repo_objs; + } else { + delete $ibxish->{coderepo}; + undef; + } + } +} + +sub _fill_ibx { + my ($self, $name) = @_; + my $pfx = "publicinbox.$name"; + my $ibx = {}; + for my $k (qw(watch)) { my $v = $self->{"$pfx.$k"}; $ibx->{$k} = $v if defined $v; } for my $k (qw(filter inboxdir newsgroup replyto httpbackendmax feedmax - indexlevel indexsequentialshard)) { - if (defined(my $v = $self->{"$pfx.$k"})) { - if (ref($v) eq 'ARRAY') { - warn <[-1]' -EOF - $ibx->{$k} = $v->[-1]; - } else { - $ibx->{$k} = $v; - } - } + indexlevel indexsequentialshard boost)) { + my $v = get_1($self, "$pfx.$k") // next; + $ibx->{$k} = $v; } # "mainrepo" is backwards compatibility: @@ -406,9 +424,8 @@ EOF warn "E: `$dir' must not contain `\\n'\n"; return; } - foreach my $k (qw(obfuscate)) { - my $v = $self->{"$pfx.$k"}; - defined $v or next; + for my $k (qw(obfuscate)) { + my $v = $self->{"$pfx.$k"} // next; if (defined(my $bval = git_bool($v))) { $ibx->{$k} = $bval; } else { @@ -417,21 +434,14 @@ EOF } # TODO: more arrays, we should support multi-value for # more things to encourage decentralization - foreach my $k (qw(address altid nntpmirror coderepo hide listid url - infourl watchheader)) { - if (defined(my $v = $self->{"$pfx.$k"})) { - $ibx->{$k} = _array($v); - } - } - - my $name = $pfx; - $name =~ s/\Apublicinbox\.//; - - if (!valid_inbox_name($name)) { - warn "invalid inbox name: '$name'\n"; - return; + for my $k (qw(address altid nntpmirror imapmirror + coderepo hide listid url + infourl watchheader nntpserver imapserver)) { + my $v = $self->{"$pfx.$k"} // next; + $ibx->{$k} = _array($v); } + return unless valid_foo_name($name, 'publicinbox'); $ibx->{name} = $name; $ibx->{-pi_cfg} = $self; $ibx = PublicInbox::Inbox->new($ibx); @@ -478,21 +488,6 @@ EOF $ibx->{-no_obfuscate_re} = $self->{-no_obfuscate_re}; fill_all($self); # noop to populate -no_obfuscate } - - if (my $ibx_code_repos = $ibx->{coderepo}) { - my $code_repos = $self->{-code_repos}; - my $repo_objs = $ibx->{-repo_objs} = []; - foreach my $nick (@$ibx_code_repos) { - my @parts = split(m!/!, $nick); - my $valid = 0; - $valid += valid_inbox_name($_) foreach (@parts); - $valid == scalar(@parts) or next; - - my $repo = $code_repos->{$nick} //= - _fill_code_repo($self, $nick); - push @$repo_objs, $repo if $repo; - } - } if (my $es = ALL($self)) { require PublicInbox::Isearch; $ibx->{isrch} = PublicInbox::Isearch->new($ibx, $es); @@ -501,17 +496,34 @@ EOF } sub _fill_ei ($$) { - my ($self, $pfx) = @_; - require PublicInbox::ExtSearch; - my $d = $self->{"$pfx.topdir"}; - defined($d) && -d $d ? PublicInbox::ExtSearch->new($d) : undef; + my ($self, $name) = @_; + eval { require PublicInbox::ExtSearch } or return; + my $pfx = "extindex.$name"; + my $d = $self->{"$pfx.topdir"} // return; + -d $d or return; + if (index($d, "\n") >= 0) { + warn "E: `$d' must not contain `\\n'\n"; + return; + } + my $es = PublicInbox::ExtSearch->new($d); + for my $k (qw(indexlevel indexsequentialshard)) { + my $v = get_1($self, "$pfx.$k") // next; + $es->{$k} = $v; + } + for my $k (qw(coderepo hide url infourl)) { + my $v = $self->{"$pfx.$k"} // next; + $es->{$k} = _array($v); + } + return unless valid_foo_name($name, 'extindex'); + $es->{name} = $name; + $es; } sub urlmatch { my ($self, $key, $url) = @_; state $urlmatch_broken; # requires git 1.8.5 return if $urlmatch_broken; - my $file = default_file(); + my $file = $self->{'-f'} // default_file(); my $cmd = [qw/git config -z --includes --get-urlmatch/, "--file=$file", $key, $url ]; my $fh = popen_rd($cmd); @@ -538,4 +550,13 @@ sub json { }; } +sub squote_maybe ($) { + my ($val) = @_; + if ($val =~ m{([^\w@\./,\%\+\-])}) { + $val =~ s/(['!])/'\\$1'/g; # '!' for csh + return "'$val'"; + } + $val; +} + 1;