# data notes:
# * NNTP article numbers are UIDs and message sequence numbers (MSNs)
# * Message sequence numbers (MSNs) can be stable since we're read-only.
-# Most IMAP clients use UIDs (I hope), and we can return a dummy
-# message if a client requests a non-existent MSN.
+# Most IMAP clients use UIDs (I hope). We may return a dummy message
+# in the future if a client requests a non-existent MSN, but that seems
+# unecessary with mutt.
package PublicInbox::IMAP;
use strict;
use base qw(PublicInbox::DS);
-use fields qw(imapd logged_in ibx long_cb -login_tag
+use fields qw(imapd ibx long_cb -login_tag
uid_min -idle_tag -idle_max);
use PublicInbox::Eml;
use PublicInbox::EmlContentFoo qw(parse_content_disposition);
use Errno qw(EAGAIN);
use Time::Local qw(timegm);
use POSIX qw(strftime);
+use Hash::Util qw(unlock_hash); # dependency of fields for perl 5.10+, anyways
my $Address;
for my $mod (qw(Email::Address::XS Mail::Address)) {
# changing this will cause grief for clients which cache
sub UID_BLOCK () { 50_000 }
-my %FETCH_NEED_BLOB = ( # for future optimization
- 'BODY[HEADER]' => 1,
- 'BODY[TEXT]' => 1,
- 'BODY[]' => 1,
- 'RFC822.HEADER' => 1,
- 'RFC822.SIZE' => 1, # needs CRLF conversion :<
- 'RFC822.TEXT' => 1,
- BODY => 1,
- BODYSTRUCTURE => 1,
- ENVELOPE => 1,
- FLAGS => 0,
- INTERNALDATE => 0,
- RFC822 => 1,
- UID => 0,
+# these values area also used for sorting
+sub NEED_SMSG () { 1 }
+sub NEED_BLOB () { NEED_SMSG|2 }
+sub NEED_EML () { NEED_BLOB|4 }
+my $OP_EML_NEW = [ NEED_EML - 1, \&op_eml_new ];
+
+my %FETCH_NEED = (
+ 'BODY[HEADER]' => [ NEED_EML, \&emit_rfc822_header ],
+ 'BODY[TEXT]' => [ NEED_EML, \&emit_rfc822_text ],
+ 'BODY[]' => [ NEED_BLOB, \&emit_rfc822 ],
+ 'RFC822.HEADER' => [ NEED_EML, \&emit_rfc822_header ],
+ 'RFC822.TEXT' => [ NEED_EML, \&emit_rfc822_text ],
+ 'RFC822.SIZE' => [ NEED_BLOB, \&emit_rfc822_size ],
+ RFC822 => [ NEED_BLOB, \&emit_rfc822 ],
+ BODY => [ NEED_EML, \&emit_body ],
+ BODYSTRUCTURE => [ NEED_EML, \&emit_bodystructure ],
+ ENVELOPE => [ NEED_EML, \&emit_envelope ],
+ FLAGS => [ 0, \&emit_flags ],
+ INTERNALDATE => [ NEED_SMSG, \&emit_internaldate ],
);
-my %FETCH_ATT = map { $_ => [ $_ ] } keys %FETCH_NEED_BLOB;
+my %FETCH_ATT = map { $_ => [ $_ ] } keys %FETCH_NEED;
# aliases (RFC 3501 section 6.4.5)
$FETCH_ATT{FAST} = [ qw(FLAGS INTERNALDATE RFC822.SIZE) ];
$FETCH_ATT{FULL} = [ @{$FETCH_ATT{ALL}}, 'BODY' ];
for my $att (keys %FETCH_ATT) {
- my %h = map { $_ => 1 } @{$FETCH_ATT{$att}};
+ my %h = map { $_ => $FETCH_NEED{$_} } @{$FETCH_ATT{$att}};
$FETCH_ATT{$att} = \%h;
}
+undef %FETCH_NEED;
my $valid_range = '[0-9]+|[0-9]+:[0-9]+|[0-9]+:\*';
$valid_range = qr/\A(?:$valid_range)(?:,(?:$valid_range))*\z/;
my %MoY;
@MoY{@MoY} = (0..11);
+# RFC 3501 5.4. Autologout Timer needs to be >= 30min
+$PublicInbox::DS::EXPTIME = 60 * 30;
+
sub greet ($) {
my ($self) = @_;
my $capa = capa($self);
sub new ($$$) {
my ($class, $sock, $imapd) = @_;
- my $self = fields::new($class);
+ my $self = fields::new('PublicInbox::IMAP_preauth');
+ unlock_hash(%$self);
my $ev = EPOLLIN;
my $wbuf;
if ($sock->can('accept_SSL') && !$sock->accept_SSL) {
$self;
}
+sub logged_in { 1 }
+
sub capa ($) {
my ($self) = @_;
# dovecot advertises IDLE pre-login; perhaps because some clients
# depend on it, so we'll do the same
my $capa = 'CAPABILITY IMAP4rev1 IDLE';
- if ($self->{logged_in}) {
+ if ($self->logged_in) {
$capa .= ' COMPRESS=DEFLATE';
} else {
if (!($self->{sock} // $self)->can('accept_SSL') &&
sub login_success ($$) {
my ($self, $tag) = @_;
- $self->{logged_in} = 1;
+ bless $self, 'PublicInbox::IMAP';
my $capa = capa($self);
"$tag OK [$capa] Logged in\r\n";
}
sub cmd_logout ($$) {
my ($self, $tag) = @_;
- delete $self->{logged_in};
+ delete $self->{-idle_tag};
$self->write(\"* BYE logging out\r\n$tag OK Logout done\r\n");
$self->shutdn; # PublicInbox::DS::shutdn
undef;
sub on_inbox_unlock {
my ($self, $ibx) = @_;
my $new = $ibx->mm->max;
+ my $uid_end = ($self->{uid_min} // 1) - 1 + UID_BLOCK;
defined(my $old = $self->{-idle_max}) or die 'BUG: -idle_max unset';
+ $new = $uid_end if $new > $uid_end;
if ($new > $old) {
$self->{-idle_max} = $new;
$self->msg_more("* $_ EXISTS\r\n") for (($old + 1)..($new - 1));
$self->write(\"* $new EXISTS\r\n");
+ } elsif ($new == $uid_end) { # max exceeded $uid_end
+ # continue idling w/o inotify
+ delete $self->{-idle_max};
+ my $sock = $self->{sock} or return;
+ $ibx->unsubscribe_unlock(fileno($sock));
+ }
+}
+
+# called every X minute(s) or so by PublicInbox::DS::later
+my $IDLERS = {};
+my $idle_timer;
+sub idle_tick_all {
+ my $old = $IDLERS;
+ $IDLERS = {};
+ for my $i (values %$old) {
+ next if ($i->{wbuf} || !exists($i->{-idle_tag}));
+ $i->update_idle_time or next;
+ $IDLERS->{fileno($i->{sock})} = $i;
+ $i->write(\"* OK Still here\r\n");
}
+ $idle_timer = scalar keys %$IDLERS ?
+ PublicInbox::DS::later(\&idle_tick_all) : undef;
}
sub cmd_idle ($$) {
my ($self, $tag) = @_;
# IDLE seems allowed by dovecot w/o a mailbox selected *shrug*
my $ibx = $self->{ibx} or return "$tag BAD no mailbox selected\r\n";
- $ibx->subscribe_unlock(fileno($self->{sock}), $self);
- $self->{imapd}->idler_start;
$self->{-idle_tag} = $tag;
- $self->{-idle_max} = $ibx->mm->max // 0;
- "+ idling\r\n"
+ my $max = $ibx->mm->max // 0;
+ my $uid_end = ($self->{uid_min} // 1) - 1 + UID_BLOCK;
+ my $sock = $self->{sock} or return;
+ my $fd = fileno($sock);
+ # only do inotify on most recent slice
+ if ($max < $uid_end) {
+ $ibx->subscribe_unlock($fd, $self);
+ $self->{imapd}->idler_start;
+ $self->{-idle_max} = $max;
+ }
+ $idle_timer //= PublicInbox::DS::later(\&idle_tick_all);
+ $IDLERS->{$fd} = $self;
+ \"+ idling\r\n"
+}
+
+sub stop_idle ($$) {
+ my ($self, $ibx);
+ my $sock = $self->{sock} or return;
+ my $fd = fileno($sock);
+ delete $IDLERS->{$fd};
+ $ibx->unsubscribe_unlock($fd);
}
sub cmd_done ($$) {
warn "BUG: idle_tag set w/o inbox";
return "$tag BAD internal bug\r\n";
};
- $ibx->unsubscribe_unlock(fileno($self->{sock}));
+ stop_idle($self, $ibx);
"$idle_tag OK Idle done\r\n";
}
join('', @hold);
}
-sub dummy_message ($$) {
- my ($self, $seqno) = @_;
- my $ret = <<EOF;
-From: nobody\@localhost\r
-To: nobody\@localhost\r
-Date: Thu, 01 Jan 1970 00:00:00 +0000\r
-Message-ID: <dummy-$seqno\@$self->{ibx}->{newsgroup}>\r
-Subject: dummy message #$seqno\r
-\r
-You're seeing this message because your IMAP client didn't use UIDs.\r
-The message which used to use this sequence number was likely spam\r
-and removed by the administrator.\r
-EOF
- \$ret;
-}
-
sub requeue_once ($) {
my ($self) = @_;
# COMPRESS users all share the same DEFLATE context.
sub uid_fetch_cb { # called by git->cat_async via git_async_cat
my ($bref, $oid, $type, $size, $fetch_m_arg) = @_;
- my ($self, undef, $msgs, undef, $want) = @$fetch_m_arg;
+ my ($self, undef, $msgs, undef, $ops, $partial) = @$fetch_m_arg;
my $smsg = shift @$msgs or die 'BUG: no smsg';
if (!defined($oid)) {
# it's possible to have TOCTOU if an admin runs
# public-inbox-(edit|purge), just move onto the next message
- return requeue_once($self) unless defined $want->{-seqno};
- $bref = dummy_message($self, $smsg->{num});
+ return requeue_once($self);
} else {
$smsg->{blob} eq $oid or die "BUG: $smsg->{blob} != $oid";
}
-
$$bref =~ s/(?<!\r)\n/\r\n/sg; # make strict clients happy
# fixup old bug from import (pre-a0c07cba0e5d8b6a)
$$bref =~ s/\A[\r\n]*From [^\r\n]*\r\n//s;
-
$self->msg_more("* $smsg->{num} FETCH (UID $smsg->{num}");
-
- $want->{'RFC822.SIZE'} and
- $self->msg_more(' RFC822.SIZE '.length($$bref));
- $want->{INTERNALDATE} and
- $self->msg_more(' INTERNALDATE "'.$smsg->internaldate.'"');
- $want->{FLAGS} and $self->msg_more(' FLAGS ()');
- for ('RFC822', 'BODY[]') {
- $want->{$_} or next;
- $self->msg_more(" $_ {".length($$bref)."}\r\n");
- $self->msg_more($$bref);
+ my $eml;
+ for (my $i = 0; $i < @$ops;) {
+ my $k = $ops->[$i++];
+ $ops->[$i++]->($self, $k, $smsg, $bref, $eml);
}
+ partial_emit($self, $partial, $eml) if $partial;
+ $self->msg_more(")\r\n");
+ requeue_once($self);
+}
- my $eml = PublicInbox::Eml->new($bref);
+sub emit_rfc822 {
+ my ($self, $k, undef, $bref) = @_;
+ $self->msg_more(" $k {" . length($$bref)."}\r\n");
+ $self->msg_more($$bref);
+}
- $want->{ENVELOPE} and
- $self->msg_more(' ENVELOPE '.eml_envelope($eml));
+# Mail::IMAPClient::message_string cares about this by default
+# (->Ignoresizeerrors attribute)
+sub emit_rfc822_size {
+ my ($self, $k, undef, $bref) = @_;
+ $self->msg_more(' RFC822.SIZE ' . length($$bref));
+}
- for ('RFC822.HEADER', 'BODY[HEADER]') {
- $want->{$_} or next;
- $self->msg_more(" $_ {".length(${$eml->{hdr}})."}\r\n");
- $self->msg_more(${$eml->{hdr}});
- }
- for ('RFC822.TEXT', 'BODY[TEXT]') {
- $want->{$_} or next;
- $self->msg_more(" $_ {".length($$bref)."}\r\n");
- $self->msg_more($$bref);
- }
- $want->{BODYSTRUCTURE} and
- $self->msg_more(' BODYSTRUCTURE '.fetch_body($eml, 1));
- $want->{BODY} and
- $self->msg_more(' BODY '.fetch_body($eml));
- if (my $partial = $want->{-partial}) {
- partial_emit($self, $partial, $eml);
- }
- $self->msg_more(")\r\n");
- requeue_once($self);
+sub emit_internaldate {
+ my ($self, undef, $smsg) = @_;
+ $self->msg_more(' INTERNALDATE "'.$smsg->internaldate.'"');
+}
+
+sub emit_flags { $_[0]->msg_more(' FLAGS ()') }
+
+sub emit_envelope {
+ my ($self, undef, undef, undef, $eml) = @_;
+ $self->msg_more(' ENVELOPE '.eml_envelope($eml));
+}
+
+sub emit_rfc822_header {
+ my ($self, $k, undef, undef, $eml) = @_;
+ $self->msg_more(" $k {".length(${$eml->{hdr}})."}\r\n");
+ $self->msg_more(${$eml->{hdr}});
}
+# n.b. this is sorted to be after any emit_eml_new ops
+sub emit_rfc822_text {
+ my ($self, $k, undef, $bref) = @_;
+ $self->msg_more(" $k {".length($$bref)."}\r\n");
+ $self->msg_more($$bref);
+}
+
+sub emit_bodystructure {
+ my ($self, undef, undef, undef, $eml) = @_;
+ $self->msg_more(' BODYSTRUCTURE '.fetch_body($eml, 1));
+}
+
+sub emit_body {
+ my ($self, undef, undef, undef, $eml) = @_;
+ $self->msg_more(' BODY '.fetch_body($eml));
+}
+
+# set $eml once ($_[4] == $eml, $_[3] == $bref)
+sub op_eml_new { $_[4] = PublicInbox::Eml->new($_[3]) }
+
sub uid_clamp ($$$) {
my ($self, $beg, $end) = @_;
my $uid_min = $self->{uid_min} or return;
undef; # keep looping
}
-sub uid_fetch_m { # long_response
- my ($self, $tag, $msgs, $range_info, $want) = @_;
+sub uid_fetch_msg { # long_response
+ my ($self, $tag, $msgs, $range_info) = @_; # \@ops, \@partial
while (!@$msgs) { # rare
if (my $end = refill_range($self, $msgs, $range_info)) {
$self->write(\"$tag $end\r\n");
\&uid_fetch_cb, \@_);
}
+sub uid_fetch_smsg { # long_response
+ my ($self, $tag, $msgs, $range_info, $ops) = @_;
+ while (!@$msgs) { # rare
+ if (my $end = refill_range($self, $msgs, $range_info)) {
+ $self->write(\"$tag $end\r\n");
+ return;
+ }
+ }
+ for my $smsg (@$msgs) {
+ $self->msg_more("* $smsg->{num} FETCH (UID $smsg->{num}");
+ for (my $i = 0; $i < @$ops;) {
+ my $k = $ops->[$i++];
+ $ops->[$i++]->($self, $k, $smsg);
+ }
+ $self->msg_more(")\r\n");
+ }
+ @$msgs = ();
+ 1; # more
+}
+
+sub uid_fetch_uid { # long_response
+ my ($self, $tag, $uids, $range_info, $ops) = @_;
+ while (!@$uids) { # rare
+ my ($beg, $end, $range_csv) = @$range_info;
+ if (scalar(@$uids = @{$self->{ibx}->over->
+ uid_range($beg, $end)})) {
+ $range_info->[0] = $uids->[-1] + 1;
+ } elsif (!$range_csv) {
+ $self->write(\"$tag OK Fetch done\r\n");
+ return;
+ } else {
+ my $next_range = range_step($self, \$range_csv);
+ if (!ref($next_range)) { # error
+ $self->write(\"$tag $next_range\r\n");
+ return;
+ }
+ @$range_info = @$next_range;
+ }
+ # continue looping
+ }
+ for (@$uids) {
+ $self->msg_more("* $_ FETCH (UID $_");
+ for (my $i = 0; $i < @$ops;) {
+ my $k = $ops->[$i++];
+ $ops->[$i++]->($self, $k);
+ }
+ $self->msg_more(")\r\n");
+ }
+ @$uids = ();
+ 1; # more
+}
+
sub cmd_status ($$$;@) {
my ($self, $tag, $mailbox, @items) = @_;
return "$tag BAD no items\r\n" if !scalar(@items);
}
}
-sub fetch_common ($$$$) {
- my ($self, $tag, $range_csv, $want) = @_;
- my $ibx = $self->{ibx} or return "$tag BAD No mailbox selected\r\n";
+sub fetch_compile ($) {
+ my ($want) = @_;
if ($want->[0] =~ s/\A\(//s) {
- $want->[-1] =~ s/\)\z//s or return "$tag BAD no rparen\r\n";
+ $want->[-1] =~ s/\)\z//s or return 'BAD no rparen';
}
- my (%partial, %want);
+ my (%partial, %seen, @op);
+ my $need = 0;
while (defined(my $att = shift @$want)) {
$att = uc($att);
+ next if $att eq 'UID'; # always returned
$att =~ s/\ABODY\.PEEK\[/BODY\[/; # we're read-only
my $x = $FETCH_ATT{$att};
if ($x) {
- %want = (%want, %$x);
+ while (my ($k, $fl_cb) = each %$x) {
+ next if $seen{$k}++;
+ $need |= $fl_cb->[0];
+
+ # insert a special op to convert $bref to $eml
+ # the first time we need it
+ if ($need == NEED_EML && !$seen{$need}++) {
+ push @op, $OP_EML_NEW;
+ }
+ # $fl_cb = [ flags, \&emit_foo ]
+ push @op, [ @$fl_cb , $k ];
+ }
} elsif (!partial_prepare(\%partial, $want, $att)) {
- return "$tag BAD param: $att\r\n";
+ return "BAD param: $att";
}
}
+ my @r;
# stabilize partial order for consistency and ease-of-debugging:
if (scalar keys %partial) {
- $want{-partial} = [ map {;
- [ $_, @{$partial{$_}} ]
- } sort keys %partial ];
+ $need = NEED_EML;
+ push @op, $OP_EML_NEW if !$seen{$need}++;
+ $r[2] = [ map { [ $_, @{$partial{$_}} ] } sort keys %partial ];
}
- $range_csv = 'bad' if $range_csv !~ $valid_range;
- my $range_info = range_step($self, \$range_csv);
- return "$tag $range_info\r\n" if !ref($range_info);
- [ $tag, [], $range_info, \%want ];
-}
-sub cmd_uid_fetch ($$$;@) {
- my ($self, $tag, $range_csv, @want) = @_;
- my $args = fetch_common($self, $tag, $range_csv, \@want);
- ref($args) eq 'ARRAY' ?
- long_response($self, \&uid_fetch_m, @$args) :
- $args; # error
-}
+ $r[0] = $need & NEED_BLOB ? \&uid_fetch_msg :
+ ($need & NEED_SMSG ? \&uid_fetch_smsg : \&uid_fetch_uid);
-sub seq_fetch_m { # long_response
- my ($self, $tag, $msgs, $range_info, $want) = @_;
- while (!@$msgs) { # rare
- if (my $end = refill_range($self, $msgs, $range_info)) {
- $self->write(\"$tag $end\r\n");
- return;
- }
- }
- my $seq = $want->{-seqno}++;
- my $cur_num = $msgs->[0]->{num};
- if ($cur_num == $seq) { # as expected
- git_async_cat($self->{ibx}->git, $msgs->[0]->{blob},
- \&uid_fetch_cb, \@_);
- } elsif ($cur_num > $seq) {
- # send dummy messages until $seq catches up to $cur_num
- my $smsg = bless { num => $seq, ts => 0 }, 'PublicInbox::Smsg';
- unshift @$msgs, $smsg;
- my $bref = dummy_message($self, $seq);
- uid_fetch_cb($bref, undef, undef, undef, \@_);
- $smsg; # blessed response since uid_fetch_cb requeues
- } else { # should not happen
- die "BUG: cur_num=$cur_num < seq=$seq";
- }
+ # r[1] = [ $key1, $cb1, $key2, $cb2, ... ]
+ use sort 'stable'; # makes output more consistent
+ $r[1] = [ map { ($_->[2], $_->[1]) } sort { $a->[0] <=> $b->[0] } @op ];
+ @r;
}
-sub cmd_fetch ($$$;@) {
+sub cmd_uid_fetch ($$$;@) {
my ($self, $tag, $range_csv, @want) = @_;
- my $args = fetch_common($self, $tag, $range_csv, \@want);
- ref($args) eq 'ARRAY' ? do {
- my $want = $args->[-1];
- $want->{-seqno} = $args->[2]->[0]; # $beg == $range_info->[0];
- long_response($self, \&seq_fetch_m, @$args)
- } : $args; # error
-}
+ my $ibx = $self->{ibx} or return "$tag BAD No mailbox selected\r\n";
+ my ($cb, $ops, $partial) = fetch_compile(\@want);
+ return "$tag $cb\r\n" unless $ops;
+ $range_csv = 'bad' if $range_csv !~ $valid_range;
+ my $range_info = range_step($self, \$range_csv);
+ return "$tag $range_info\r\n" if !ref($range_info);
+ long_response($self, $cb, $tag, [], $range_info, $ops, $partial);
+}
sub parse_date ($) { # 02-Oct-1993
my ($date_text) = @_;
}
sub uid_search_uid_range { # long_response
- my ($self, $tag, $beg, $end) = @_;
- my $uids = $self->{ibx}->mm->msg_range($beg, $end, 'num');
+ my ($self, $tag, $beg, $end, $sql) = @_;
+ my $uids = $self->{ibx}->over->uid_range($$beg, $end, $sql);
if (@$uids) {
- $self->msg_more(join('', map { " $_->[0]" } @$uids));
+ $$beg = $uids->[-1] + 1;
+ $self->msg_more(join(' ', '', @$uids));
} else {
$self->write(\"\r\n$tag OK Search done\r\n");
undef;
my $ibx = $self->{ibx} or return "$tag BAD No mailbox selected\r\n";
my $q = parse_query($self, \@_);
return "$tag $q\r\n" if !ref($q);
+ my $sql = delete $q->{sql};
if (!scalar(keys %$q)) {
$self->msg_more('* SEARCH');
my $beg = $self->{uid_min} // 1;
my $end = $ibx->mm->max;
uid_clamp($self, \$beg, \$end);
- long_response($self, \&uid_search_uid_range, $tag, \$beg, $end);
+ long_response($self, \&uid_search_uid_range,
+ $tag, \$beg, $end, $sql);
} elsif (my $uid = $q->{uid}) {
if ($uid =~ /\A([0-9]+):([0-9]+|\*)\z/s) {
my ($beg, $end) = ($1, $2);
uid_clamp($self, \$beg, \$end);
$self->msg_more('* SEARCH');
long_response($self, \&uid_search_uid_range,
- $tag, \$beg, $end);
+ $tag, \$beg, $end, $sql);
} elsif ($uid =~ /\A[0-9]+\z/s) {
$uid = $ibx->over->get_art($uid) ? " $uid" : '';
"* SEARCH$uid\r\n$tag OK Search done\r\n";
sub close {
my ($self) = @_;
if (my $ibx = delete $self->{ibx}) {
- if (my $sock = $self->{sock}) {;
- $ibx->unsubscribe_unlock(fileno($sock));
- }
+ stop_idle($self, $ibx);
}
$self->SUPER::close; # PublicInbox::DS::close
}
# we're read-only, so SELECT and EXAMINE do the same thing
no warnings 'once';
*cmd_select = \&cmd_examine;
+*cmd_fetch = \&cmd_uid_fetch;
+
+package PublicInbox::IMAP_preauth;
+our @ISA = qw(PublicInbox::IMAP);
+
+sub logged_in { 0 }
1;