-# 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)
package PublicInbox::Inbox;
use strict;
+use v5.10.1;
use PublicInbox::Git;
use PublicInbox::MID qw(mid2path);
use PublicInbox::Eml;
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)};
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;
$self->{mm} //= eval {
require PublicInbox::Msgmap;
_cleanup_later($self);
- PublicInbox::Msgmap->new_file(mm_file($self));
+ PublicInbox::Msgmap->new_file($self);
} // ($req ? croak("E: $@") : undef);
}
} // ($req ? croak("E: $@") : undef);
}
-sub try_cat {
- my ($path) = @_;
- open(my $fh, '<', $path) or return '';
- local $/;
- <$fh> // '';
-}
-
-sub cat_desc ($) {
- my $desc = try_cat($_[0]);
- local $/ = "\n";
- chomp $desc;
- utf8::decode($desc);
- $desc =~ s/\s+/ /smg;
- $desc eq '' ? undef : $desc;
-}
-
sub description {
my ($self) = @_;
- ($self->{description} //= cat_desc("$self->{inboxdir}/description")) //
+ ($self->{description} //=
+ PublicInbox::Git::cat_desc("$self->{inboxdir}/description")) //
'($INBOX_DIR/description missing)';
}
sub cloneurl {
my ($self) = @_;
$self->{cloneurl} // do {
- my $s = try_cat("$self->{inboxdir}/cloneurl");
- my @urls = split(/\s+/s, $s);
+ my @urls = split(/\s+/s,
+ PublicInbox::Git::try_cat("$self->{inboxdir}/cloneurl"));
scalar(@urls) ? ($self->{cloneurl} = \@urls) : undef;
} // [];
}
$url .= '/' if $url !~ m!/\z!;
return $url .= $self->{name} . '/';
}
- # called from a non-PSGI environment (e.g. NNTP/POP3):
+ # called from a non-PSGI environment or cross-inbox environment
+ # where multiple inboxes can have different domains
my $url = $self->{url} // return undef;
$url = $url->[0] // return undef;
# expand protocol-relative URLs to HTTPS if we're
$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"} //
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
}
# 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!\Apop3?s?://! ? $_ : "pop3://$_" } @$ps;
+ if (my $mi = $self->{'pop3mirror'}) {
+ my @m = map { m!\Apop3?s?://! ? $_ : "pop3://$_" } @$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) = @_;
# ghosts may have undef smsg (from SearchThread.node) or
# no {blob} field
- return unless defined $smsg;
- defined(my $blob = $smsg->{blob}) or return;
-
- $self->git->cat_file($blob);
+ $smsg // return;
+ $self->git->cat_file($smsg->{blob} // return);
}
sub smsg_eml {
my ($self, $smsg) = @_;
my $bref = msg_by_smsg($self, $smsg) or return;
my $eml = PublicInbox::Eml->new($bref);
- $smsg->populate($eml) unless exists($smsg->{num}); # v1 w/o SQLite
+ $smsg->{num} // $smsg->populate($eml);
$eml;
}
my $smsg;
if (my $mm = $self->mm) {
# favor the Message-ID we used for the NNTP article number:
- defined(my $num = $mm->num_for($mid)) or return;
+ my $num = $mm->num_for($mid) // return;
$smsg = $over->get_art($num);
} else {
my ($id, $prev);
$smsg ? msg_by_smsg($self, $smsg) : msg_by_path($self, mid2path($mid));
}
-sub recent {
- my ($self, $opts, $after, $before) = @_;
- $self->over->recent($opts, $after, $before);
-}
-
sub modified {
my ($self) = @_;
if (my $over = $self->over) {
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};
sprintf('-%x', uidvalidity($self) // 0)
}
+sub thing_type { 'public inbox' }
+
1;