]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/Inbox.pm
update copyrights for 2021
[public-inbox.git] / lib / PublicInbox / Inbox.pm
index 64b12345b22dc6a5cdfb9c41380957a293921159..bee44f8a92e7ae8861b01064ff10831605b51a1f 100644 (file)
@@ -1,13 +1,13 @@
-# Copyright (C) 2016-2020 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2021 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 #
 # Represents a public-inbox (which may have multiple mailing addresses)
 package PublicInbox::Inbox;
 use strict;
-use warnings;
 use PublicInbox::Git;
 use PublicInbox::MID qw(mid2path);
 use PublicInbox::Eml;
+use List::Util qw(max);
 
 # Long-running "git-cat-file --batch" processes won't notice
 # unlinked packs, so we need to restart those processes occasionally.
@@ -74,18 +74,8 @@ sub _cleanup_later ($) {
        $CLEANUP->{"$self"} = $self;
 }
 
-sub _set_uint ($$$) {
-       my ($opts, $field, $default) = @_;
-       my $val = $opts->{$field};
-       if (defined $val) {
-               $val = $val->[-1] if ref($val) eq 'ARRAY';
-               $val = undef if $val !~ /\A[0-9]+\z/;
-       }
-       $opts->{$field} = $val || $default;
-}
-
 sub _set_limiter ($$$) {
-       my ($self, $pi_config, $pfx) = @_;
+       my ($self, $pi_cfg, $pfx) = @_;
        my $lkey = "-${pfx}_limiter";
        $self->{$lkey} ||= do {
                # full key is: publicinbox.$NAME.httpbackendmax
@@ -96,7 +86,7 @@ sub _set_limiter ($$$) {
                        require PublicInbox::Qspawn;
                        $lim = PublicInbox::Qspawn::Limiter->new($val);
                } elsif ($val =~ /\A[a-z][a-z0-9]*\z/) {
-                       $lim = $pi_config->limiter($val);
+                       $lim = $pi_cfg->limiter($val);
                        warn "$mkey limiter=$val not found\n" if !$lim;
                } else {
                        warn "$mkey limiter=$val not understood\n";
@@ -110,14 +100,15 @@ sub new {
        my $v = $opts->{address} ||= [ 'public-inbox@example.com' ];
        my $p = $opts->{-primary_address} = ref($v) eq 'ARRAY' ? $v->[0] : $v;
        $opts->{domain} = ($p =~ /\@(\S+)\z/) ? $1 : 'localhost';
-       my $pi_config = delete $opts->{-pi_config};
-       _set_limiter($opts, $pi_config, 'httpbackend');
-       _set_uint($opts, 'feedmax', 25);
-       $opts->{nntpserver} ||= $pi_config->{'publicinbox.nntpserver'};
-       my $dir = $opts->{inboxdir};
-       if (defined $dir && -f "$dir/inbox.lock") {
-               $opts->{version} = 2;
+       my $pi_cfg = delete $opts->{-pi_cfg};
+       _set_limiter($opts, $pi_cfg, 'httpbackend');
+       my $fmax = $opts->{feedmax};
+       if (defined($fmax) && $fmax =~ /\A[0-9]+\z/) {
+               $opts->{feedmax} += 0;
+       } else {
+               delete $opts->{feedmax};
        }
+       $opts->{nntpserver} ||= $pi_cfg->{'publicinbox.nntpserver'};
 
        # allow any combination of multi-line or comma-delimited hide entries
        my $hide = {};
@@ -130,17 +121,18 @@ sub new {
        bless $opts, $class;
 }
 
-sub version { $_[0]->{version} // 1 }
+sub version {
+       $_[0]->{version} //= -f "$_[0]->{inboxdir}/inbox.lock" ? 2 : 1
+}
 
 sub git_epoch {
-       my ($self, $epoch) = @_;
-       $self->version == 2 or return;
+       my ($self, $epoch) = @_; # v2-only, callers always supply $epoch
        $self->{"$epoch.git"} ||= do {
                my $git_dir = "$self->{inboxdir}/git/$epoch.git";
                return unless -d $git_dir;
                my $g = PublicInbox::Git->new($git_dir);
                $g->{-httpbackend_limiter} = $self->{-httpbackend_limiter};
-               # no cleanup needed, we never cat-file off this, only clone
+               # caller must manually cleanup when done
                $g;
        };
 }
@@ -161,19 +153,15 @@ sub max_git_epoch {
        my ($self) = @_;
        return if $self->version < 2;
        my $cur = $self->{-max_git_epoch};
-       my $changed = git($self)->alternates_changed;
-       if (!defined($cur) || $changed) {
+       my $changed;
+       if (!defined($cur) || ($changed = git($self)->alternates_changed)) {
                git_cleanup($self) if $changed;
                my $gits = "$self->{inboxdir}/git";
                if (opendir my $dh, $gits) {
-                       my $max = -1;
-                       while (defined(my $git_dir = readdir($dh))) {
-                               $git_dir =~ m!\A([0-9]+)\.git\z! or next;
-                               $max = $1 if $1 > $max;
-                       }
-                       $cur = $self->{-max_git_epoch} = $max if $max >= 0;
-               } else {
-                       warn "opendir $gits failed: $!\n";
+                       my $max = max(map {
+                               substr($_, 0, -4) + 0; # drop ".git" suffix
+                       } grep(/\A[0-9]+\.git\z/, readdir($dh))) // return;
+                       $cur = $self->{-max_git_epoch} = $max;
                }
        }
        $cur;
@@ -192,38 +180,39 @@ sub mm {
        };
 }
 
-sub search ($;$$) {
-       my ($self, $over_only, $ctx) = @_;
-       my $srch = $self->{search} ||= eval {
+sub search {
+       my ($self) = @_;
+       my $srch = $self->{search} //= eval {
                _cleanup_later($self);
                require PublicInbox::Search;
                PublicInbox::Search->new($self);
        };
-       ($over_only || eval { $srch->xdb }) ? $srch : do {
-               $ctx and $ctx->{env}->{'psgi.errors'}->print(<<EOF);
-`$self->{name}' search went away unexpectedly
-EOF
-               undef;
-       };
+       (eval { $srch->xdb }) ? $srch : undef;
 }
 
+# isrch is preferred for read-only interfaces if available since it
+# reduces kernel cache and FD overhead
+sub isrch { $_[0]->{isrch} // search($_[0]) }
+
 sub over {
        $_[0]->{over} //= eval {
-               my $srch = search($_[0], 1) or return;
+               my $srch = $_[0]->{search} //= eval {
+                       _cleanup_later($_[0]);
+                       require PublicInbox::Search;
+                       PublicInbox::Search->new($_[0]);
+               };
                my $over = PublicInbox::Over->new("$srch->{xpfx}/over.sqlite3");
                $over->dbh; # may fail
                $over;
        };
 }
 
+
 sub try_cat {
        my ($path) = @_;
-       my $rv = '';
-       if (open(my $fh, '<', $path)) {
-               local $/;
-               $rv = <$fh>;
-       }
-       $rv;
+       open(my $fh, '<', $path) or return '';
+       local $/;
+       <$fh> // '';
 }
 
 sub cat_desc ($) {
@@ -422,12 +411,14 @@ sub on_unlock {
        my ($self) = @_;
        check_inodes($self);
        my $subs = $self->{unlock_subs} or return;
-       for (values %$subs) {
-               eval { $_->on_inbox_unlock($self) };
+       for my $obj (values %$subs) {
+               eval { $obj->on_inbox_unlock($self) };
                warn "E: $@ ($self->{inboxdir})\n" if $@;
        }
 }
 
-sub uidvalidity  { $_[0]->{uidvalidity} //= $_[0]->mm->created_at }
+sub uidvalidity { $_[0]->{uidvalidity} //= eval { $_[0]->mm->created_at } }
+
+sub eidx_key { $_[0]->{newsgroup} // $_[0]->{inboxdir} }
 
 1;