X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FConfig.pm;h=b7e03af37e652b9e758a2b0646ed2fdab530c3c7;hb=1317fb7b4ace03f6d9dfb1a42ee5f9371a1bf913;hp=cd8854888c9dfe29e5ba0c96859d2a19bfc28c19;hpb=58a5bb3e18901237b1ca34ef8f03f696be27d305;p=public-inbox.git diff --git a/lib/PublicInbox/Config.pm b/lib/PublicInbox/Config.pm index cd885488..b7e03af3 100644 --- a/lib/PublicInbox/Config.pm +++ b/lib/PublicInbox/Config.pm @@ -1,39 +1,78 @@ -# Copyright (C) 2014-2015 all contributors -# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +# Copyright (C) 2014-2019 all contributors +# License: AGPL-3.0+ # # Used throughout the project for reading configuration +# +# Note: I hate camelCase; but git-config(1) uses it, but it's better +# than alllowercasewithoutunderscores, so use lc('configKey') where +# applicable for readability + package PublicInbox::Config; use strict; use warnings; require PublicInbox::Inbox; use PublicInbox::Spawn qw(popen_rd); +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) = @_; $file = default_file() unless defined($file); - $file = ref $file ? $file : git_config_dump($file); - my $self = bless $file, $class; - + 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", '='); + } else { + $self = git_config_dump($file); + } + bless $self, $class; # caches $self->{-by_addr} ||= {}; + $self->{-by_list_id} ||= {}; $self->{-by_name} ||= {}; $self->{-by_newsgroup} ||= {}; + $self->{-no_obfuscate} ||= {}; $self->{-limiters} ||= {}; + $self->{-code_repos} ||= {}; # nick => PublicInbox::Git object + $self->{-cgitrc_unparsed} = $self->{'publicinbox.cgitrc'}; + + if (my $no = delete $self->{'publicinbox.noobfuscate'}) { + $no = _array($no); + my @domains; + foreach my $n (@$no) { + my @n = split(/\s+/, $n); + foreach (@n) { + if (/\S+@\S+/) { # full address + $self->{-no_obfuscate}->{lc $_} = 1; + } else { + # allow "example.com" or "@example.com" + s/\A@//; + push @domains, quotemeta($_); + } + } + } + my $nod = join('|', @domains); + $self->{-no_obfuscate_re} = qr/(?:$nod)\z/i; + } + if (my $css = delete $self->{'publicinbox.css'}) { + $self->{css} = _array($css); + } + $self; } sub lookup { my ($self, $recipient) = @_; my $addr = lc($recipient); - my $inbox = $self->{-by_addr}->{$addr}; - return $inbox if $inbox; + my $ibx = $self->{-by_addr}->{$addr}; + return $ibx if $ibx; my $pfx; foreach my $k (keys %$self) { - $k =~ /\A(publicinbox\.[\w-]+)\.address\z/ or next; + $k =~ m!\A(publicinbox\.[^/]+)\.address\z! or next; my $v = $self->{$k}; if (ref($v) eq "ARRAY") { foreach my $alias (@$v) { @@ -51,6 +90,33 @@ sub lookup { _fill($self, $pfx); } +sub lookup_list_id { + my ($self, $list_id) = @_; + $list_id = lc($list_id); + my $ibx = $self->{-by_list_id}->{$list_id}; + return $ibx if $ibx; + + my $pfx; + + foreach my $k (keys %$self) { + $k =~ /\A(publicinbox\.[\w-]+)\.listid\z/ or next; + my $v = $self->{$k}; + if (ref($v) eq "ARRAY") { + foreach my $alias (@$v) { + (lc($alias) eq $list_id) or next; + $pfx = $1; + last; + } + } else { + (lc($v) eq $list_id) or next; + $pfx = $1; + last; + } + } + defined $pfx or return; + _fill($self, $pfx); +} + sub lookup_name ($$) { my ($self, $name) = @_; $self->{-by_name}->{$name} || _fill($self, "publicinbox.$name"); @@ -58,11 +124,10 @@ sub lookup_name ($$) { sub each_inbox { my ($self, $cb) = @_; - my %seen; - foreach my $k (keys %$self) { - $k =~ /\Apublicinbox\.([A-Z0-9a-z-]+)\.mainrepo\z/ or next; - next if $seen{$1}; - $seen{$1} = 1; + # may auto-vivify if config file is non-existent: + foreach my $section (@{$self->{-section_order}}) { + next if $section !~ m!\Apublicinbox\.([^/]+)\z!; + $self->{"publicinbox.$1.mainrepo"} or next; my $ibx = lookup_name($self, $1) or next; $cb->($ibx); } @@ -71,16 +136,16 @@ sub each_inbox { sub lookup_newsgroup { my ($self, $ng) = @_; $ng = lc($ng); - my $rv = $self->{-by_newsgroup}->{$ng}; - return $rv if $rv; + my $ibx = $self->{-by_newsgroup}->{$ng}; + return $ibx if $ibx; foreach my $k (keys %$self) { - $k =~ /\A(publicinbox\.[\w-]+)\.newsgroup\z/ or next; + $k =~ m!\A(publicinbox\.[^/]+)\.newsgroup\z! or next; my $v = $self->{$k}; my $pfx = $1; if ($v eq $ng) { - $rv = _fill($self, $pfx); - return $rv; + $ibx = _fill($self, $pfx); + return $ibx; } } undef; @@ -90,17 +155,13 @@ sub limiter { my ($self, $name) = @_; $self->{-limiters}->{$name} ||= do { require PublicInbox::Qspawn; - my $key = "limiter.$name.max"; - PublicInbox::Qspawn::Limiter->new($self->{$key}); + my $max = $self->{"publicinboxlimiter.$name.max"} || 1; + my $limiter = PublicInbox::Qspawn::Limiter->new($max); + $limiter->setup_rlimit($name, $self); + $limiter; }; } -sub get { - my ($self, $inbox, $key) = @_; - - $self->{"publicinbox.$inbox.$key"}; -} - sub config_dir { $ENV{PI_DIR} || "$ENV{HOME}/.public-inbox" } sub default_file { @@ -109,19 +170,21 @@ sub default_file { config_dir() . '/config'; } -sub git_config_dump { - my ($file) = @_; - my ($in, $out); - my @cmd = (qw/git config/, "--file=$file", '-l'); - my $cmd = join(' ', @cmd); - my $fh = popen_rd(\@cmd) or die "popen_rd failed for $file: $!\n"; +sub config_fh_parse ($$$) { + my ($fh, $rs, $fs) = @_; my %rv; - local $/ = "\n"; - foreach my $line (<$fh>) { + my (%section_seen, @section_order); + local $/ = $rs; + while (defined(my $line = <$fh>)) { chomp $line; - my ($k, $v) = split(/=/, $line, 2); - my $cur = $rv{$k}; + 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) { if (ref($cur) eq "ARRAY") { push @$cur, $v; @@ -132,41 +195,291 @@ sub git_config_dump { $rv{$k} = $v; } } - close $fh or die "failed to close ($cmd) pipe: $?"; + $rv{-section_order} = \@section_order; + \%rv; } +sub git_config_dump { + my ($file) = @_; + return {} unless -e $file; + my @cmd = (qw/git config -z -l/, "--file=$file"); + my $cmd = join(' ', @cmd); + my $fh = popen_rd(\@cmd) or die "popen_rd failed for $file: $!\n"; + my $rv = config_fh_parse($fh, "\0", "\n"); + close $fh or die "failed to close ($cmd) pipe: $?"; + $rv; +} + +sub valid_inbox_name ($) { + my ($name) = @_; + + # Similar rules found in git.git/remote.c::valid_remote_nick + # and git.git/refs.c::check_refname_component + # We don't reject /\.lock\z/, however, since we don't lock refs + if ($name eq '' || $name =~ /\@\{/ || + $name =~ /\.\./ || $name =~ m![/:\?\[\]\^~\s\f[:cntrl:]\*]! || + $name =~ /\A\./ || $name =~ /\.\z/) { + return 0; + } + + # Note: we allow URL-unfriendly characters; users may configure + # non-HTTP-accessible inboxes + 1; +} + +# XXX needs testing for cgit compatibility +# cf. cgit/scan-tree.c::add_repo +sub cgit_repo_merge ($$$) { + my ($self, $base, $repo) = @_; + my $path = $repo->{dir}; + if (defined(my $se = $self->{-cgit_strict_export})) { + return unless -e "$path/$se"; + } + return if -e "$path/noweb"; + # $repo = { url => 'foo.git', dir => '/path/to/foo.git' } + my $rel = $repo->{url}; + unless (defined $rel) { + my $off = index($path, $base, 0); + if ($off != 0) { + $rel = $path; + } else { + $rel = substr($path, length($base) + 1); + } + + $rel =~ s!/\.git\z!! or + $rel =~ s!/+\z!!; + + $self->{-cgit_remove_suffix} and + $rel =~ s!/?\.git\z!!; + } + $self->{"coderepo.$rel.dir"} ||= $path; + $self->{"coderepo.$rel.cgiturl"} ||= $rel; +} + +sub is_git_dir ($) { + my ($git_dir) = @_; + -d "$git_dir/objects" && -f "$git_dir/HEAD"; +} + +# XXX needs testing for cgit compatibility +sub scan_path_coderepo { + my ($self, $base, $path) = @_; + opendir(my $dh, $path) or do { + warn "error opening directory: $path\n"; + return + }; + my $git_dir = $path; + if (is_git_dir($git_dir) || is_git_dir($git_dir .= '/.git')) { + my $repo = { dir => $git_dir }; + cgit_repo_merge($self, $base, $repo); + return; + } + while (defined(my $dn = readdir $dh)) { + next if $dn eq '.' || $dn eq '..'; + if (index($dn, '.') == 0 && !$self->{-cgit_scan_hidden_path}) { + next; + } + my $dir = "$path/$dn"; + scan_path_coderepo($self, $base, $dir) if -d $dir; + } +} + +sub scan_tree_coderepo ($$) { + my ($self, $path) = @_; + scan_path_coderepo($self, $path, $path); +} + +sub scan_projects_coderepo ($$$) { + my ($self, $list, $path) = @_; + open my $fh, '<', $list or do { + warn "failed to open cgit projectlist=$list: $!\n"; + return; + }; + foreach (<$fh>) { + chomp; + scan_path_coderepo($self, $path, "$path/$_"); + } +} + +sub parse_cgitrc { + my ($self, $cgitrc, $nesting) = @_; + if ($nesting == 0) { + # defaults: + my %s = map { $_ => 1 } qw(/cgit.css /cgit.png + /favicon.ico /robots.txt); + $self->{-cgit_static} = \%s; + } + + # same limit as cgit/configfile.c::parse_configfile + return if $nesting > 8; + + open my $fh, '<', $cgitrc or do { + warn "failed to open cgitrc=$cgitrc: $!\n"; + return; + }; + + # FIXME: this doesn't support macro expansion via $VARS, yet + my $repo; + foreach (<$fh>) { + chomp; + if (m!\Arepo\.url=(.+?)/*\z!) { + my $nick = $1; + cgit_repo_merge($self, $repo->{dir}, $repo) if $repo; + $repo = { url => $nick }; + } elsif (m!\Arepo\.path=(.+)\z!) { + if (defined $repo) { + $repo->{dir} = $1; + } else { + warn "$_ without repo.url\n"; + } + } elsif (m!\Ainclude=(.+)\z!) { + parse_cgitrc($self, $1, $nesting + 1); + } elsif (m!\A(scan-hidden-path|remove-suffix)=([0-9]+)\z!) { + my ($k, $v) = ($1, $2); + $k =~ tr/-/_/; + $self->{"-cgit_$k"} = $v; + } elsif (m!\A(project-list|strict-export)=(.+)\z!) { + my ($k, $v) = ($1, $2); + $k =~ tr/-/_/; + $self->{"-cgit_$k"} = $v; + } elsif (m!\Ascan-path=(.+)\z!) { + if (defined(my $list = $self->{-cgit_project_list})) { + scan_projects_coderepo($self, $list, $1); + } else { + scan_tree_coderepo($self, $1); + } + } elsif (m!\A(?:css|favicon|logo|repo\.logo)=(/.+)\z!) { + # absolute paths for static files via PublicInbox::Cgit + $self->{-cgit_static}->{$1} = 1; + } + } + cgit_repo_merge($self, $repo->{dir}, $repo) if $repo; +} + +# parse a code repo +# Only git is supported at the moment, but SVN and Hg are possibilities +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) { + 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 (my $cgits = $self->{lc("$pfx.cgitUrl")}) { + $git->{cgit_url} = $cgits = _array($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 _git_config_bool ($) { + my ($val) = @_; + if ($val =~ /\A(?:false|no|off|[\-\+]?(?:0x)?0+)\z/i) { + 0; + } elsif ($val =~ /\A(?:true|yes|on|[\-\+]?(?:0x)?[0-9]+)\z/i) { + 1; + } else { + undef; + } +} + sub _fill { my ($self, $pfx) = @_; - my $rv = {}; + my $ibx = {}; - foreach my $k (qw(mainrepo address filter url newsgroup - infourl watch watchheader httpbackendmax)) { + foreach my $k (qw(mainrepo filter url newsgroup + infourl watch watchheader httpbackendmax + replyto feedmax nntpserver indexlevel)) { + my $v = $self->{"$pfx.$k"}; + $ibx->{$k} = $v if defined $v; + } + foreach my $k (qw(obfuscate)) { my $v = $self->{"$pfx.$k"}; - $rv->{$k} = $v if defined $v; + defined $v or next; + if (defined(my $bval = _git_config_bool($v))) { + $ibx->{$k} = $bval; + } else { + warn "Ignoring $pfx.$k=$v in config, not boolean\n"; + } } - foreach my $k (qw(altid)) { # TODO: more arrays + # TODO: more arrays, we should support multi-value for + # more things to encourage decentralization + foreach my $k (qw(address altid nntpmirror coderepo hide listid)) { if (defined(my $v = $self->{"$pfx.$k"})) { - $rv->{$k} = [ $v ]; + $ibx->{$k} = _array($v); } } - return unless $rv->{mainrepo}; + return unless $ibx->{mainrepo}; my $name = $pfx; $name =~ s/\Apublicinbox\.//; - $rv->{name} = $name; - $rv->{-pi_config} = $self; - $rv = PublicInbox::Inbox->new($rv); - my $v = $rv->{address}; - if (ref($v) eq 'ARRAY') { - $self->{-by_addr}->{lc($_)} = $rv foreach @$v; - } else { - $self->{-by_addr}->{lc($v)} = $rv; + + if (!valid_inbox_name($name)) { + warn "invalid inbox name: '$name'\n"; + return; + } + + $ibx->{name} = $name; + $ibx->{-pi_config} = $self; + $ibx = PublicInbox::Inbox->new($ibx); + foreach (@{$ibx->{address}}) { + my $lc_addr = lc($_); + $self->{-by_addr}->{$lc_addr} = $ibx; + $self->{-no_obfuscate}->{$lc_addr} = 1; } - if (my $ng = $rv->{newsgroup}) { - $self->{-by_newsgroup}->{$ng} = $rv; + if (my $listids = $ibx->{listid}) { + foreach my $list_id (@$listids) { + $self->{-by_list_id}->{$list_id} = $ibx; + } } - $self->{-by_name}->{$name} = $rv; + if (my $ng = $ibx->{newsgroup}) { + $self->{-by_newsgroup}->{$ng} = $ibx; + } + $self->{-by_name}->{$name} = $ibx; + if ($ibx->{obfuscate}) { + $ibx->{-no_obfuscate} = $self->{-no_obfuscate}; + $ibx->{-no_obfuscate_re} = $self->{-no_obfuscate_re}; + each_inbox($self, sub {}); # 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; + } + } + + $ibx } 1;