miscidx: index inbox min/max article numbers

[public-inbox.git] / lib / PublicInbox / Inbox.pm

diff --git a/lib/PublicInbox/Inbox.pm b/lib/PublicInbox/Inbox.pm
index b7b71268187e86ce8f6f583e5391d645da8fb7f5..3f70e69d53d3229e4a5a78bde97ce3ff1b31c571 100644 (file)
--- a/lib/PublicInbox/Inbox.pm
+++ b/lib/PublicInbox/Inbox.pm
@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2021 all contributors <meta@public-inbox.org>
+# Copyright (C) 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)
@@ -28,7 +28,7 @@ sub do_cleanup {
                check_inodes($ibx);
        } else {
                delete(@$ibx{qw(over mm description cloneurl
-                               -imap_url -nntp_url)});
+                               -imap_url -nntp_url -pop3_url)});
        }
        my $srch = $ibx->{search} // $ibx;
        delete @$srch{qw(xdb qp)};
@@ -48,7 +48,7 @@ sub _cleanup_later ($) {
 sub _set_limiter ($$$) {
        my ($self, $pi_cfg, $pfx) = @_;
        my $lkey = "-${pfx}_limiter";
-       $self->{$lkey} ||= do {
+       $self->{$lkey} //= do {
                # full key is: publicinbox.$NAME.httpbackendmax
                my $mkey = $pfx.'max';
                my $val = $self->{$mkey} or return;
@@ -230,8 +230,9 @@ sub base_url {
        $url;
 }
 
+# imapserver, nntpserver configs are used here:
 sub _x_url ($$$) {
-       my ($self, $x, $ctx) = @_; # $x is "nntp" or "imap"
+       my ($self, $x, $ctx) = @_; # $x is "imap" or "nntp"
        # no checking for nntp_usable here, we can point entirely
        # to non-local servers or users run by a different user
        my $ns = $self->{"${x}server"} //
@@ -253,7 +254,7 @@ sub _x_url ($$$) {
                                if ($group) {
                                        $u .= '/' if $u !~ m!/\z!;
                                        $u .= $group;
-                               } else { # n.b. IMAP uses "newsgroup"
+                               } else { # n.b. IMAP and POP3 use "newsgroup"
                                        warn <<EOM;
 publicinbox.$self->{name}.${x}mirror=$_ missing newsgroup name
 EOM
@@ -273,8 +274,31 @@ EOM
 }
 
 # my ($self, $ctx) = @_;
-sub nntp_url { $_[0]->{-nntp_url} //= _x_url($_[0], 'nntp', $_[1]) }
 sub imap_url { $_[0]->{-imap_url} //= _x_url($_[0], 'imap', $_[1]) }
+sub nntp_url { $_[0]->{-nntp_url} //= _x_url($_[0], 'nntp', $_[1]) }
+
+sub pop3_url {
+       my ($self, $ctx) = @_;
+       $self->{-pop3_url} //= do {
+               my $ps = $self->{'pop3server'} //
+                      $ctx->{www}->{pi_cfg}->get_all('publicinbox.pop3server');
+               my $group = $self->{newsgroup};
+               my @urls;
+               ($ps && $group) and
+                       @urls = map { m!\Apops?://! ? $_ : "pop://$_" } @$ps;
+               if (my $mi = $self->{'pop3mirror'}) {
+                       my @m = map { m!\Apops?://! ? $_ : "pop://$_" } @$mi;
+                       my %seen; # List::Util::uniq requires Perl 5.26+
+                       @urls = grep { !$seen{$_}++ } (@urls, @m);
+               }
+               my $n = 0;
+               for (@urls) { $n += s!/+\z!! }
+               warn <<EOM if $n;
+W: pop3server and/or pop3mirror URLs should not end with trailing slash `/'
+EOM
+               \@urls;
+       }
+}
 
 sub nntp_usable {
        my ($self) = @_;
@@ -385,6 +409,16 @@ sub uidvalidity { $_[0]->{uidvalidity} //= eval { $_[0]->mm->created_at } }
 
 sub eidx_key { $_[0]->{newsgroup} // $_[0]->{inboxdir} }
 
+# only used by NNTP, so we need ->mm anyways
+sub art_min { $_[0]->{-art_min} //= eval { $_[0]->mm(1)->min } }
+
+# used by IMAP, too, which tries to avoid ->mm (but ->{mm} is likely
+# faster since it's smaller iff available)
+sub art_max {
+       $_[0]->{-art_max} //= eval { $_[0]->{mm}->max } //
+                               eval { $_[0]->over(1)->max };
+}
+
 sub mailboxid { # rfc 8474, 8620, 8621
        my ($self, $imap_slice) = @_;
        my $pfx = defined($imap_slice) ? $self->{newsgroup} : $self->{name};