# 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 ibx long_cb -login_tag
- uid_min -idle_tag -idle_max);
+ uid_base -idle_tag -idle_max);
use PublicInbox::Eml;
use PublicInbox::EmlContentFoo qw(parse_content_disposition);
use PublicInbox::DS qw(now);
}
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 }
# 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 ];
+sub CRLF_BREF () { 4 }
+sub EML_HDR () { 8 }
+sub CRLF_HDR () { 16 }
+sub EML_BDY () { 32 }
+sub CRLF_BDY () { 64 }
+my $OP_EML_NEW = [ EML_HDR - 1, \&op_eml_new ];
+my $OP_CRLF_BREF = [ CRLF_BREF, \&op_crlf_bref ];
+my $OP_CRLF_HDR = [ CRLF_HDR, \&op_crlf_hdr ];
+my $OP_CRLF_BDY = [ CRLF_BDY, \&op_crlf_bdy ];
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 ],
+ 'BODY[HEADER]' => [ NEED_BLOB|EML_HDR|CRLF_HDR, \&emit_rfc822_header ],
+ 'BODY[TEXT]' => [ NEED_BLOB|EML_BDY|CRLF_BDY, \&emit_rfc822_text ],
+ 'BODY[]' => [ NEED_BLOB|CRLF_BREF, \&emit_rfc822 ],
+ 'RFC822.HEADER' => [ NEED_BLOB|EML_HDR|CRLF_HDR, \&emit_rfc822_header ],
+ 'RFC822.TEXT' => [ NEED_BLOB|EML_BDY|CRLF_BDY, \&emit_rfc822_text ],
'RFC822.SIZE' => [ NEED_SMSG, \&emit_rfc822_size ],
- RFC822 => [ NEED_BLOB, \&emit_rfc822 ],
- BODY => [ NEED_EML, \&emit_body ],
- BODYSTRUCTURE => [ NEED_EML, \&emit_bodystructure ],
- ENVELOPE => [ NEED_EML, \&emit_envelope ],
+ RFC822 => [ NEED_BLOB|CRLF_BREF, \&emit_rfc822 ],
+ BODY => [ NEED_BLOB|EML_HDR|EML_BDY, \&emit_body ],
+ BODYSTRUCTURE => [ NEED_BLOB|EML_HDR|EML_BDY, \&emit_bodystructure ],
+ ENVELOPE => [ NEED_BLOB|EML_HDR, \&emit_envelope ],
FLAGS => [ 0, \&emit_flags ],
INTERNALDATE => [ NEED_SMSG, \&emit_internaldate ],
);
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 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
} 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}");
- 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);
}
# set $eml once ($_[4] == $eml, $_[3] == $bref)
sub op_eml_new { $_[4] = PublicInbox::Eml->new($_[3]) }
+# s/From / fixes old bug from import (pre-a0c07cba0e5d8b6a)
+sub to_crlf_full {
+ ${$_[0]} =~ s/(?<!\r)\n/\r\n/sg;
+ ${$_[0]} =~ s/\A[\r\n]*From [^\r\n]*\r\n//s;
+}
+
+sub op_crlf_bref { to_crlf_full($_[3]) }
+
+sub op_crlf_hdr { to_crlf_full($_[4]->{hdr}) }
+
+sub op_crlf_bdy { ${$_[4]->{bdy}} =~ s/(?<!\r)\n/\r\n/sg if $_[4]->{bdy} }
+
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"));
}
join('', ($str =~ m/($hdrs_re)/g), "\r\n");
}
-sub partial_prepare ($$$) {
- my ($partial, $want, $att) = @_;
+sub partial_prepare ($$$$) {
+ my ($need, $partial, $want, $att) = @_;
# recombine [ "BODY[1.HEADER.FIELDS", "(foo", "bar)]" ]
# back to: "BODY[1.HEADER.FIELDS (foo bar)]"
(?:\.(HEADER|MIME|TEXT))? # 2 - section_name
\](?:<([0-9]+)(?:\.([0-9]+))?>)?\z/sx) { # 3, 4
$partial->{$att} = [ \&partial_body, $1, $2, $3, $4 ];
+ $$need |= CRLF_BREF|EML_HDR|EML_BDY;
} elsif ($att =~ /\ABODY\[(?:([0-9]+(?:\.[0-9]+)*)\.)? # 1 - section_idx
(?:HEADER\.FIELDS(\.NOT)?)\x20 # 2
\(([A-Z0-9\-\x20]+)\) # 3 - hdrs
: \&partial_hdr_get,
$1, undef, $4, $5 ];
$tmp->[2] = hdrs_regexp($3);
+ $$need |= CRLF_HDR|EML_HDR;
} else {
undef;
}
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 ];
+ push @op, [ @$fl_cb, $k ];
}
- } elsif (!partial_prepare(\%partial, $want, $att)) {
+ } elsif (!partial_prepare(\$need, \%partial, $want, $att)) {
return "BAD param: $att";
}
}
# stabilize partial order for consistency and ease-of-debugging:
if (scalar keys %partial) {
- $need = NEED_EML;
- push @op, $OP_EML_NEW if !$seen{$need}++;
+ $need |= NEED_BLOB;
$r[2] = [ map { [ $_, @{$partial{$_}} ] } sort keys %partial ];
}
- $r[0] = $need & NEED_BLOB ? \&uid_fetch_msg :
- ($need & NEED_SMSG ? \&uid_fetch_smsg : \&uid_fetch_uid);
+ push @op, $OP_EML_NEW if ($need & (EML_HDR|EML_BDY));
+
+ # do we need CRLF conversion?
+ if ($need & CRLF_BREF) {
+ push @op, $OP_CRLF_BREF;
+ } elsif (my $crlf = ($need & (CRLF_HDR|CRLF_BDY))) {
+ if ($crlf == (CRLF_HDR|CRLF_BDY)) {
+ push @op, $OP_CRLF_BREF;
+ } elsif ($need & CRLF_HDR) {
+ push @op, $OP_CRLF_HDR;
+ } else {
+ push @op, $OP_CRLF_BDY;
+ }
+ }
+
+ $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
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);