# slow storage.
#
# 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). We may return a dummy message
-# in the future if a client requests a non-existent MSN, but that seems
-# unecessary with mutt.
+# * NNTP article numbers are UIDs
package PublicInbox::IMAP;
use strict;
use base qw(PublicInbox::DS);
-use fields qw(imapd logged_in ibx long_cb -login_tag
- uid_min -idle_tag -idle_max);
+use fields qw(imapd ibx long_cb -login_tag
+ uid_base -idle_tag -idle_max);
use PublicInbox::Eml;
use PublicInbox::EmlContentFoo qw(parse_content_disposition);
use PublicInbox::DS qw(now);
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)) {
}
die "neither Email::Address::XS nor Mail::Address loaded: $@" if !$Address;
-sub LINE_MAX () { 512 } # does RFC 3501 have a limit like RFC 977?
+sub LINE_MAX () { 8000 } # RFC 2683 3.2.1.5
# changing this will cause grief for clients which cache
sub UID_BLOCK () { 50_000 }
'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.SIZE' => [ NEED_SMSG, \&emit_rfc822_size ],
RFC822 => [ NEED_BLOB, \&emit_rfc822 ],
BODY => [ NEED_EML, \&emit_body ],
BODYSTRUCTURE => [ NEED_EML, \&emit_bodystructure ],
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_close ($$) {
my ($self, $tag) = @_;
- delete $self->{uid_min};
+ delete $self->{uid_base};
delete $self->{ibx} ? "$tag OK Close done\r\n"
: "$tag BAD No mailbox\r\n";
}
sub cmd_logout ($$) {
my ($self, $tag) = @_;
- delete @$self{qw(logged_in -idle_tag)};
+ 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;
+ my $uid_base = $self->{uid_base} // 0;
+ my $uid_end = $uid_base + 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;
+ $new -= $uid_base;
+ $old -= $uid_base;
$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
my $ibx = $self->{ibx} or return "$tag BAD no mailbox selected\r\n";
$self->{-idle_tag} = $tag;
my $max = $ibx->mm->max // 0;
- my $uid_end = ($self->{uid_min} // 1) - 1 + UID_BLOCK;
+ my $uid_end = $self->{uid_base} + UID_BLOCK;
my $sock = $self->{sock} or return;
my $fd = fileno($sock);
# only do inotify on most recent slice
sub ensure_ranges_exist ($$$) {
my ($imapd, $ibx, $max) = @_;
+ defined(my $mb_top = $ibx->{newsgroup}) or return;
my $mailboxes = $imapd->{mailboxes};
- my $mb_top = $ibx->{newsgroup};
my @created;
for (my $i = int($max/UID_BLOCK); $i >= 0; --$i) {
my $sub_mailbox = "$mb_top.$i";
last if exists $mailboxes->{$sub_mailbox};
$mailboxes->{$sub_mailbox} = $ibx;
+ $sub_mailbox =~ s/\Ainbox\./INBOX./i; # more familiar to users
push @created, $sub_mailbox;
}
return unless @created;
sub inbox_lookup ($$) {
my ($self, $mailbox) = @_;
- my ($ibx, $exists, $uidnext);
+ my ($ibx, $exists, $uidnext, $uid_base);
if ($mailbox =~ /\A(.+)\.([0-9]+)\z/) {
# old mail: inbox.comp.foo.$uid_block_idx
- my ($mb_top, $uid_min) = ($1, $2 * UID_BLOCK + 1);
-
+ my $mb_top = $1;
+ $uid_base = $2 * UID_BLOCK;
$ibx = $self->{imapd}->{mailboxes}->{lc $mailbox} or return;
$exists = $ibx->mm->max // 0;
- $self->{uid_min} = $uid_min;
ensure_ranges_exist($self->{imapd}, $ibx, $exists);
- my $uid_end = $uid_min + UID_BLOCK - 1;
+ my $uid_end = $uid_base + UID_BLOCK;
$exists = $uid_end if $exists > $uid_end;
$uidnext = $exists + 1;
+ $exists -= $uid_base;
} else { # check for dummy inboxes
$ibx = $self->{imapd}->{mailboxes}->{lc $mailbox} or return;
- delete $self->{uid_min};
- $exists = 0;
+ $uid_base = $exists = 0;
$uidnext = 1;
}
- ($ibx, $exists, $uidnext);
+ ($ibx, $exists, $uidnext, $uid_base);
}
sub cmd_examine ($$$) {
my ($self, $tag, $mailbox) = @_;
- my ($ibx, $exists, $uidnext) = inbox_lookup($self, $mailbox);
+ my ($ibx, $exists, $uidnext, $base) = inbox_lookup($self, $mailbox);
return "$tag NO Mailbox doesn't exist: $mailbox\r\n" if !$ibx;
+ $self->{uid_base} = $base;
# XXX: do we need this? RFC 5162/7162
my $ret = $self->{ibx} ? "* OK [CLOSED] previous closed\r\n" : '';
$self->requeue if $new_size == 1;
}
-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, $ops, $partial) = @$fetch_m_arg;
+# my ($uid_base, $UID) = @_;
+sub fetch_msn_uid ($$) { '* '.($_[1] - $_[0]).' FETCH (UID '.$_[1] }
+
+sub fetch_run_ops {
+ my ($self, $uid_base, $smsg, $bref, $ops, $partial) = @_;
+ $self->msg_more(fetch_msn_uid($uid_base, $smsg->{num}));
+ my ($eml, $k);
+ for (my $i = 0; $i < @$ops;) {
+ $k = $ops->[$i++];
+ $ops->[$i++]->($self, $k, $smsg, $bref, $eml);
+ }
+ partial_emit($self, $partial, $eml) if $partial;
+ $self->msg_more(")\r\n");
+}
+
+sub fetch_blob_cb { # called by git->cat_async via git_async_cat
+ my ($bref, $oid, $type, $size, $fetch_arg) = @_;
+ my ($self, undef, $msgs, undef, $ops, $partial) = @$fetch_arg;
my $smsg = shift @$msgs or die 'BUG: no smsg';
if (!defined($oid)) {
# it's possible to have TOCTOU if an admin runs
# 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}");
- 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");
+ fetch_run_ops($self, $self->{uid_base}, $smsg, $bref, $ops, $partial);
requeue_once($self);
}
$self->msg_more($$bref);
}
-# Mail::IMAPClient::message_string cares about this by default
-# (->Ignoresizeerrors attribute)
+# Mail::IMAPClient::message_string cares about this by default,
+# (->Ignoresizeerrors attribute). Admins are encouraged to
+# --reindex for IMAP support, anyways.
sub emit_rfc822_size {
- my ($self, $k, undef, $bref) = @_;
- $self->msg_more(' RFC822.SIZE ' . length($$bref));
+ my ($self, $k, $smsg) = @_;
+ $self->msg_more(' RFC822.SIZE ' . $smsg->{bytes});
}
sub emit_internaldate {
sub uid_clamp ($$$) {
my ($self, $beg, $end) = @_;
- my $uid_min = $self->{uid_min} or return;
+ my $uid_min = $self->{uid_base} + 1;
my $uid_end = $uid_min + UID_BLOCK - 1;
$$beg = $uid_min if $$beg < $uid_min;
$$end = $uid_end if $$end > $uid_end;
} elsif ($range =~ /\A([0-9]+):\*\z/) {
$beg = $1 + 0;
$end = $self->{ibx}->mm->max // 0;
- my $uid_end = ($self->{uid_min} // 1) - 1 + UID_BLOCK;
+ my $uid_end = $self->{uid_base} + UID_BLOCK;
$end = $uid_end if $end > $uid_end;
$beg = $end if $beg > $end;
} elsif ($range =~ /\A[0-9]+\z/) {
undef; # keep looping
}
-sub uid_fetch_msg { # long_response
- my ($self, $tag, $msgs, $range_info) = @_; # \@ops, \@partial
+sub fetch_blob { # 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");
}
}
git_async_cat($self->{ibx}->git, $msgs->[0]->{blob},
- \&uid_fetch_cb, \@_);
+ \&fetch_blob_cb, \@_);
}
-sub uid_fetch_smsg { # long_response
+sub fetch_smsg { # long_response
my ($self, $tag, $msgs, $range_info, $ops) = @_;
while (!@$msgs) { # rare
if (my $end = refill_range($self, $msgs, $range_info)) {
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");
- }
+ my $uid_base = $self->{uid_base};
+ fetch_run_ops($self, $uid_base, $_, undef, $ops) for @$msgs;
@$msgs = ();
1; # more
}
-sub uid_fetch_uid { # long_response
+sub 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->
}
# continue looping
}
+ my $uid_base = $self->{uid_base};
+ my ($i, $k);
for (@$uids) {
- $self->msg_more("* $_ FETCH (UID $_");
- for (my $i = 0; $i < @$ops;) {
- my $k = $ops->[$i++];
+ $self->msg_more(fetch_msn_uid($uid_base, $_));
+ for ($i = 0; $i < @$ops;) {
+ $k = $ops->[$i++];
$ops->[$i++]->($self, $k);
}
$self->msg_more(")\r\n");
# request for hierarchy delimiter
$l = [ qq[* LIST (\\Noselect) "." ""\r\n] ];
} elsif ($refname ne '' || $wildcard ne '*') {
- $wildcard = lc $wildcard;
- $wildcard =~ s!([^a-z0-9_])!$patmap{$1} // "\Q$1"!eg;
- $l = [ grep(/ \Q$refname\E$wildcard\r\n\z/s, @$l) ];
+ $wildcard =~ s!([^a-z0-9_])!$patmap{$1} // "\Q$1"!egi;
+ $l = [ grep(/ \Q$refname\E$wildcard\r\n\z/is, @$l) ];
}
\(join('', @$l, "$tag OK List done\r\n"));
}
$r[2] = [ map { [ $_, @{$partial{$_}} ] } sort keys %partial ];
}
- $r[0] = $need & NEED_BLOB ? \&uid_fetch_msg :
- ($need & NEED_SMSG ? \&uid_fetch_smsg : \&uid_fetch_uid);
+ $r[0] = $need & NEED_BLOB ? \&fetch_blob :
+ ($need & NEED_SMSG ? \&fetch_smsg : \&fetch_uid);
# r[1] = [ $key1, $cb1, $key2, $cb2, ... ]
use sort 'stable'; # makes output more consistent
@r;
}
-sub cmd_uid_fetch ($$$;@) {
+sub cmd_uid_fetch ($$$$;@) {
my ($self, $tag, $range_csv, @want) = @_;
my $ibx = $self->{ibx} or return "$tag BAD No mailbox selected\r\n";
my ($cb, $ops, $partial) = fetch_compile(\@want);
long_response($self, $cb, $tag, [], $range_info, $ops, $partial);
}
+sub msn_to_uid_range ($$) {
+ my $uid_base = $_[0]->{uid_base};
+ $_[1] =~ s/([0-9]+)/$uid_base + $1/sge;
+}
+
+sub cmd_fetch ($$$$;@) {
+ my ($self, $tag, $range_csv, @want) = @_;
+ 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;
+
+ # cb is one of fetch_blob, fetch_smsg, fetch_uid
+ $range_csv = 'bad' if $range_csv !~ $valid_range;
+ msn_to_uid_range($self, $range_csv);
+ 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) = @_;
my ($dd, $mon, $yyyy) = split(/-/, $_[0], 3);
# default criteria
next if $k =~ /\A(?:ALL|RECENT|UNSEEN|NEW)\z/;
next if $k eq 'AND'; # the default, until we support OR
- if ($k =~ $valid_range) { # sequence numbers == UIDs
+ if ($k =~ $valid_range) { # convert sequence numbers to UIDs
+ msn_to_uid_range($self, $k);
push @{$q->{uid}}, $k;
} elsif ($k eq 'UID') {
$k = shift(@$rest) // '';
if (!scalar(keys %$q)) {
$self->msg_more('* SEARCH');
- my $beg = $self->{uid_min} // 1;
- my $end = $ibx->mm->max;
+ my $beg = 1;
+ my $end = $ibx->mm->max // 0;
uid_clamp($self, \$beg, \$end);
long_response($self, \&uid_search_uid_range,
$tag, \$beg, $end, $sql);
my $rbuf = $self->{rbuf} // \(my $x = '');
my $line = index($$rbuf, "\n");
while ($line < 0) {
- return $self->close if length($$rbuf) >= LINE_MAX;
+ if (length($$rbuf) >= LINE_MAX) {
+ $self->write(\"\* BAD request too long\r\n");
+ return $self->close;
+ }
$self->do_read($rbuf, LINE_MAX, length($$rbuf)) or return;
$line = index($$rbuf, "\n");
}
# 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;