-# Copyright (C) 2020 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 an IMAPD (currently a singleton),
-# see script/public-inbox-imapd for how it is used
+# represents an IMAPD, see script/public-inbox-imapd for how it is used
package PublicInbox::IMAPD;
use strict;
+use v5.10.1;
use PublicInbox::Config;
use PublicInbox::InboxIdle;
use PublicInbox::IMAP;
sub new {
my ($class) = @_;
bless {
- mailboxes => {},
+ # mailboxes => {},
err => \*STDERR,
out => \*STDOUT,
- # accept_tls => { SSL_server => 1, ..., SSL_reuse_ctx => ... }
- # pi_config => PublicInbox::Config
+ # ssl_ctx_opt => { SSL_cert_file => ..., SSL_key_file => ... }
+ # pi_cfg => PublicInbox::Config
# idler => PublicInbox::InboxIdle
}, $class;
}
-sub imapd_refresh_ibx { # pi_config->each_inbox cb
- my ($ibx, $imapd) = @_;
- my $ngname = $ibx->{newsgroup} or return;
- if (ref $ngname) {
- warn 'multiple newsgroups not supported: '.
- join(', ', @$ngname). "\n";
- return;
- } elsif ($ngname =~ m![^a-z0-9/_\.\-\~\@\+\=:]! ||
- $ngname =~ /\.[0-9]+\z/) {
+sub _refresh_ibx { # pi_cfg->each_inbox cb
+ my ($ibx, $imapd, $cache, $dummies) = @_;
+ my $ngname = $ibx->{newsgroup} // return;
+
+ # We require lower-case since IMAP mailbox names are
+ # case-insensitive (but -nntpd matches INN in being
+ # case-sensitive)
+ if ($ngname =~ m![^a-z0-9/_\.\-\~\@\+\=:]! ||
+ # don't confuse with 50K slices
+ $ngname =~ /\.[0-9]+\z/) {
warn "mailbox name invalid: newsgroup=`$ngname'\n";
return;
}
- $ibx->over or return;
- $ibx->{over} = undef;
- my $mm = $ibx->mm or return;
- $ibx->{mm} = undef;
-
- # RFC 3501 2.3.1.1 - "A good UIDVALIDITY value to use in
- # this case is a 32-bit representation of the creation
- # date/time of the mailbox"
- defined($ibx->{uidvalidity} = $mm->created_at) or return;
- PublicInbox::IMAP::ensure_ranges_exist($imapd, $ibx, $mm->max // 1);
-
- # preload to avoid fragmentation:
- $ibx->description;
- $ibx->base_url;
-
- # ensure dummies are selectable
- my $dummies = $imapd->{dummies};
- do {
- $dummies->{$ngname} = $dummy;
- } while ($ngname =~ s/\.[^\.]+\z//);
-}
-
-sub imapd_refresh_finalize {
- my ($imapd, $pi_config) = @_;
- my $mailboxes;
- if (my $next = delete $imapd->{imapd_next}) {
- $imapd->{mailboxes} = delete $next->{mailboxes};
- $mailboxes = delete $next->{dummies};
- } else {
- $mailboxes = delete $imapd->{dummies};
- }
- %$mailboxes = (%$mailboxes, %{$imapd->{mailboxes}});
- $imapd->{mailboxes} = $mailboxes;
- $imapd->{inboxlist} = [
- map {
- my $no = $mailboxes->{$_} == $dummy ? '' : 'No';
- my $u = $_; # capitalize "INBOX" for user-familiarity
- $u =~ s/\Ainbox(\.|\z)/INBOX$1/i;
- qq[* LIST (\\Has${no}Children) "." $u\r\n]
- } sort {
- # shortest names first, alphabetically if lengths match
- length($a) == length($b) ?
- ($a cmp $b) :
- (length($a) <=> length($b))
- } keys %$mailboxes
- ];
- $imapd->{pi_config} = $pi_config;
- if (my $idler = $imapd->{idler}) {
- $idler->refresh($pi_config);
- }
-}
-
-sub imapd_refresh_step { # pi_config->iterate_start cb
- my ($pi_config, $section, $imapd) = @_;
- if (defined($section)) {
- return if $section !~ m!\Apublicinbox\.([^/]+)\z!;
- my $ibx = $pi_config->lookup_name($1) or return;
- imapd_refresh_ibx($ibx, $imapd->{imapd_next});
- } else { # undef == "EOF"
- imapd_refresh_finalize($imapd, $pi_config);
+ my $ce = $cache->{$ngname};
+ %$ibx = (%$ibx, %$ce) if $ce;
+ # only valid if msgmap and over works:
+ if (defined($ibx->uidvalidity)) {
+ # fill ->{mailboxes}:
+ PublicInbox::IMAP::ensure_slices_exist($imapd, $ibx);
+ # preload to avoid fragmentation:
+ $ibx->description;
+ # ensure dummies are selectable:
+ do {
+ $dummies->{$ngname} = $dummy;
+ } while ($ngname =~ s/\.[^\.]+\z//);
}
+ delete @$ibx{qw(mm over)};
}
sub refresh_groups {
my ($self, $sig) = @_;
- my $pi_config = PublicInbox::Config->new;
- if ($sig) { # SIGHUP is handled through the event loop
- $self->{imapd_next} = { dummies => {}, mailboxes => {} };
- $pi_config->iterate_start(\&imapd_refresh_step, $self);
- PublicInbox::DS::requeue($pi_config); # call event_step
- } else { # initial start is synchronous
- $self->{dummies} = {};
- $pi_config->each_inbox(\&imapd_refresh_ibx, $self);
- imapd_refresh_finalize($self, $pi_config);
+ my $pi_cfg = PublicInbox::Config->new;
+ $self->{mailboxes} = $pi_cfg->{-imap_mailboxes} // do {
+ my $mailboxes = $self->{mailboxes} = {};
+ my $cache = eval { $pi_cfg->ALL->misc->nntpd_cache_load } // {};
+ my $dummies = {};
+ $pi_cfg->each_inbox(\&_refresh_ibx, $self, $cache, $dummies);
+ %$mailboxes = (%$dummies, %$mailboxes);
+ @{$pi_cfg->{-imap_mailboxlist}} = map { $_->[2] }
+ sort { $a->[0] cmp $b->[0] || $a->[1] <=> $b->[1] }
+ map {
+ # capitalize "INBOX" for user-familiarity
+ my $u = $_;
+ $u =~ s/\Ainbox(\.|\z)/INBOX$1/i;
+ if ($mailboxes->{$_} == $dummy) {
+ [ $u, -1,
+ qq[* LIST (\\HasChildren) "." $u\r\n]]
+ } else {
+ $u =~ /\A(.+)\.([0-9]+)\z/ or die
+"BUG: `$u' has no slice digit(s)";
+ [ $1, $2 + 0, '* LIST '.
+ qq[(\\HasNoChildren) "." $u\r\n] ]
+ }
+ } keys %$mailboxes;
+ $pi_cfg->{-imap_mailboxes} = $mailboxes;
+ };
+ $self->{mailboxlist} = $pi_cfg->{-imap_mailboxlist} //
+ die 'BUG: no mailboxlist';
+ $self->{pi_cfg} = $pi_cfg;
+ if (my $idler = $self->{idler}) {
+ $idler->refresh($pi_cfg);
}
}
sub idler_start {
- $_[0]->{idler} //= PublicInbox::InboxIdle->new($_[0]->{pi_config});
+ $_[0]->{idler} //= PublicInbox::InboxIdle->new($_[0]->{pi_cfg});
+}
+
+sub event_step { # called vai requeue for low-priority IMAP clients
+ my ($self) = @_;
+ my $imap = shift(@{$self->{-authed_q}}) // return;
+ PublicInbox::DS::requeue($self) if scalar(@{$self->{-authed_q}});
+ $imap->event_step; # PublicInbox::IMAP::event_step
}
1;