]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/Inbox.pm
www: support publicinbox.imapserver
[public-inbox.git] / lib / PublicInbox / Inbox.pm
index 863a5de442187ca7d7e946e3076b4d4e936e5b8a..6cd20ec0b0418a088785e8ac0e70a94f0419688e 100644 (file)
@@ -1,4 +1,4 @@
-# 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)
@@ -8,6 +8,7 @@ use PublicInbox::Git;
 use PublicInbox::MID qw(mid2path);
 use PublicInbox::Eml;
 use List::Util qw(max);
+use Carp qw(croak);
 
 # Long-running "git-cat-file --batch" processes won't notice
 # unlinked packs, so we need to restart those processes occasionally.
@@ -108,8 +109,6 @@ sub new {
        } else {
                delete $opts->{feedmax};
        }
-       $opts->{nntpserver} ||= $pi_cfg->{'publicinbox.nntpserver'};
-
        # allow any combination of multi-line or comma-delimited hide entries
        my $hide = {};
        if (defined(my $h = $opts->{hide})) {
@@ -132,7 +131,7 @@ sub git_epoch {
                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;
        };
 }
@@ -168,8 +167,8 @@ sub max_git_epoch {
 }
 
 sub mm {
-       my ($self) = @_;
-       $self->{mm} ||= eval {
+       my ($self, $req) = @_;
+       $self->{mm} //= eval {
                require PublicInbox::Msgmap;
                my $dir = $self->{inboxdir};
                if ($self->version >= 2) {
@@ -177,7 +176,7 @@ sub mm {
                } else {
                        PublicInbox::Msgmap->new($dir);
                }
-       };
+       } // ($req ? croak("E: $@") : undef);
 }
 
 sub search {
@@ -195,27 +194,24 @@ sub search {
 sub isrch { $_[0]->{isrch} // search($_[0]) }
 
 sub over {
-       $_[0]->{over} //= eval {
-               my $srch = $_[0]->{search} //= eval {
-                       _cleanup_later($_[0]);
+       my ($self, $req) = @_;
+       $self->{over} //= eval {
+               my $srch = $self->{search} //= do {
+                       _cleanup_later($self);
                        require PublicInbox::Search;
-                       PublicInbox::Search->new($_[0]);
+                       PublicInbox::Search->new($self);
                };
                my $over = PublicInbox::Over->new("$srch->{xpfx}/over.sqlite3");
                $over->dbh; # may fail
                $over;
-       };
+       } // ($req ? croak("E: $@") : undef);
 }
 
-
 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 ($) {
@@ -244,7 +240,7 @@ sub cloneurl {
 
 sub base_url {
        my ($self, $env) = @_; # env - PSGI env
-       if ($env) {
+       if ($env && $env->{'psgi.url_scheme'}) {
                my $url = PublicInbox::Git::host_prefix_url($env, '');
                # for mount in Plack::Builder
                $url .= '/' if $url !~ m!/\z!;
@@ -252,7 +248,8 @@ sub base_url {
        }
        # called from a non-PSGI environment (e.g. NNTP/POP3):
        $self->{-base_url} ||= do {
-               my $url = $self->{url}->[0] or return undef;
+               my $url = $self->{url} // return undef;
+               $url = $url->[0] // return undef;
                # expand protocol-relative URLs to HTTPS if we're
                # not inside a web server
                $url = "https:$url" if $url =~ m!\A//!;
@@ -261,51 +258,52 @@ sub base_url {
        };
 }
 
-sub nntp_url {
-       my ($self) = @_;
-       $self->{-nntp_url} ||= do {
-               # no checking for nntp_usable here, we can point entirely
-               # to non-local servers or users run by a different user
-               my $ns = $self->{nntpserver};
-               my $group = $self->{newsgroup};
-               my @urls;
-               if ($ns && $group) {
-                       $ns = [ $ns ] if ref($ns) ne 'ARRAY';
-                       @urls = map {
-                               my $u = m!\Anntps?://! ? $_ : "nntp://$_";
-                               $u .= '/' if $u !~ m!/\z!;
-                               $u.$group;
-                       } @$ns;
-               }
-
-               my $mirrors = $self->{nntpmirror};
-               if ($mirrors) {
-                       my @m;
-                       foreach (@$mirrors) {
-                               my $u = m!\Anntps?://! ? $_ : "nntp://$_";
-                               if ($u =~ m!\Anntps?://[^/]+/?\z!) {
-                                       if ($group) {
-                                               $u .= '/' if $u !~ m!/\z!;
-                                               $u .= $group;
-                                       } else {
-                                               warn
-"publicinbox.$self->{name}.nntpmirror=$_ missing newsgroup name\n";
-                                       }
+sub _x_url ($$$) {
+       my ($self, $x, $ctx) = @_; # $x is "nntp" or "imap"
+       # 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"} //
+              $ctx->{www}->{pi_cfg}->get_all("publicinbox.${x}server");
+       my $group = $self->{newsgroup};
+       my @urls;
+       if ($ns && $group) {
+               @urls = map {
+                       my $u = m!\A${x}s?://! ? $_ : "$x://$_";
+                       $u .= '/' if $u !~ m!/\z!;
+                       $u.$group;
+               } @$ns;
+       }
+       if (my $mirrors = $self->{"${x}mirror"}) {
+               my @m;
+               for (@$mirrors) {
+                       my $u = m!\A${x}s?://! ? $_ : "$x://$_";
+                       if ($u =~ m!\A${x}s?://[^/]+/?\z!) {
+                               if ($group) {
+                                       $u .= '/' if $u !~ m!/\z!;
+                                       $u .= $group;
+                               } else { # n.b. IMAP uses "newsgroup"
+                                       warn <<EOM;
+publicinbox.$self->{name}.${x}mirror=$_ missing newsgroup name
+EOM
                                }
-                               # else: allow full URLs like:
-                               # nntp://news.example.com/alt.example
-                               push @m, $u;
                        }
-
-                       # List::Util::uniq requires Perl 5.26+, maybe we
-                       # can use it by 2030 or so
-                       my %seen;
-                       @urls = grep { !$seen{$_}++ } (@urls, @m);
+                       # else: allow full URLs like:
+                       # nntp://news.example.com/alt.example
+                       push @m, $u;
                }
-               \@urls;
-       };
+
+               # List::Util::uniq requires Perl 5.26+, maybe we
+               # can use it by 2030 or so
+               my %seen;
+               @urls = grep { !$seen{$_}++ } (@urls, @m);
+       }
+       \@urls;
 }
 
+# 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_usable {
        my ($self) = @_;
        my $ret = mm($self) && over($self);
@@ -414,8 +412,8 @@ 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 $@;
        }
 }
@@ -424,4 +422,16 @@ sub uidvalidity { $_[0]->{uidvalidity} //= eval { $_[0]->mm->created_at } }
 
 sub eidx_key { $_[0]->{newsgroup} // $_[0]->{inboxdir} }
 
+sub mailboxid { # rfc 8474, 8620, 8621
+       my ($self, $imap_slice) = @_;
+       my $pfx = defined($imap_slice) ? $self->{newsgroup} : $self->{name};
+       utf8::encode($pfx); # to octets
+       # RFC 8620, 1.2 recommends not starting with dash or digits
+       # "A good solution to these issues is to prefix every id with a single
+       #  alphabetical character."
+       'M'.join('', map { sprintf('%02x', ord) } split(//, $pfx)) .
+               (defined($imap_slice) ? sprintf('-%x', $imap_slice) : '') .
+               sprintf('-%x', uidvalidity($self) // 0)
+}
+
 1;