use strict;
use base qw(PublicInbox::DS);
use fields qw(imapd logged_in ibx long_cb -login_tag
- -idle_tag -idle_max);
+ uid_min -idle_tag -idle_max);
use PublicInbox::Eml;
use PublicInbox::EmlContentFoo qw(parse_content_disposition);
use PublicInbox::DS qw(now);
sub LINE_MAX () { 512 } # does RFC 3501 have a limit like RFC 977?
+# 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,
$FETCH_ATT{$att} = \%h;
}
+my $valid_range = '[0-9]+|[0-9]+:[0-9]+|[0-9]+:\*';
+$valid_range = qr/\A(?:$valid_range)(?:,(?:$valid_range))*\z/;
+
sub greet ($) {
my ($self) = @_;
my $capa = capa($self);
sub cmd_close ($$) {
my ($self, $tag) = @_;
+ delete $self->{uid_min};
delete $self->{ibx} ? "$tag OK Close done\r\n"
: "$tag BAD No mailbox\r\n";
}
"$idle_tag OK Idle done\r\n";
}
+sub ensure_ranges_exist ($$$) {
+ my ($imapd, $ibx, $max) = @_;
+ 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;
+ push @created, $sub_mailbox;
+ }
+ return unless @created;
+ my $l = $imapd->{inboxlist} or return;
+ push @$l, map { qq[* LIST (\\HasNoChildren) "." $_\r\n] } @created;
+}
+
sub cmd_examine ($$$) {
my ($self, $tag, $mailbox) = @_;
- my $ibx = $self->{imapd}->{groups}->{$mailbox} or
- return "$tag NO Mailbox doesn't exist: $mailbox\r\n";
- my $mm = $ibx->mm;
- my $max = $mm->max // 0;
- # 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"
- my $uidvalidity = $mm->created_at or return "$tag BAD UIDVALIDITY\r\n";
+ my ($ibx, $mm, $max);
+
+ if ($mailbox =~ /\A(.+)\.([0-9]+)\z/) {
+ # old mail: inbox.comp.foo.$uid_block_idx
+ my ($mb_top, $uid_min) = ($1, $2 * UID_BLOCK + 1);
+
+ $ibx = $self->{imapd}->{mailboxes}->{lc $mailbox} or
+ return "$tag NO Mailbox doesn't exist: $mailbox\r\n";
+
+ $mm = $ibx->mm;
+ $max = $mm->max // 0;
+ $self->{uid_min} = $uid_min;
+ ensure_ranges_exist($self->{imapd}, $ibx, $max);
+ my $uid_end = $uid_min + UID_BLOCK - 1;
+ $max = $uid_end if $max > $uid_end;
+ } else { # check for dummy inboxes
+ $ibx = $self->{imapd}->{mailboxes}->{lc $mailbox} or
+ return "$tag NO Mailbox doesn't exist: $mailbox\r\n";
+ delete $self->{uid_min};
+ $max = 0;
+ $mm = $ibx->mm;
+ }
+
my $uidnext = $max + 1;
# XXX: do we need this? RFC 5162/7162
* $max RECENT\r
* FLAGS (\\Seen)\r
* OK [PERMANENTFLAGS ()] Read-only mailbox\r
+* OK [UNSEEN $max]\r
+* OK [UIDNEXT $uidnext]\r
+* OK [UIDVALIDITY $ibx->{uidvalidity}]\r
+$tag OK [READ-ONLY] EXAMINE/SELECT done\r
EOF
- $ret .= "* OK [UNSEEN $max]\r\n" if $max;
- $ret .= "* OK [UIDNEXT $uidnext]\r\n" if defined $uidnext;
- $ret .= "* OK [UIDVALIDITY $uidvalidity]\r\n" if defined $uidvalidity;
- $ret .= "$tag OK [READ-ONLY] EXAMINE/SELECT done\r\n";
}
sub _esc ($) {
}
sub dummy_message ($$) {
- my ($seqno, $ibx) = @_;
+ 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\@$ibx->{newsgroup}>\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
$self->requeue if $new_size == 1;
}
-sub uid_fetch_cb { # called by git->cat_async via git_async_msg
+sub uid_fetch_cb { # called by git->cat_async via git_async_cat
my ($bref, $oid, $type, $size, $fetch_m_arg) = @_;
- my ($self, undef, $ibx, undef, undef, $msgs, $want) = @$fetch_m_arg;
+ my ($self, undef, $msgs, undef, $want) = @$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($smsg->{num}, $ibx);
+ $bref = dummy_message($self, $smsg->{num});
} 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)
requeue_once($self);
}
+sub range_step ($$) {
+ my ($self, $range_csv) = @_;
+ my ($beg, $end, $range);
+ if ($$range_csv =~ s/\A([^,]+),//) {
+ $range = $1;
+ } else {
+ $range = $$range_csv;
+ $$range_csv = undef;
+ }
+ if ($range =~ /\A([0-9]+):([0-9]+)\z/) {
+ ($beg, $end) = ($1 + 0, $2 + 0);
+ } elsif ($range =~ /\A([0-9]+):\*\z/) {
+ $beg = $1 + 0;
+ $end = $self->{ibx}->mm->max // 0;
+ $beg = $end if $beg > $end;
+ } elsif ($range =~ /\A[0-9]+\z/) {
+ $beg = $end = $range + 0;
+ undef $range;
+ } else {
+ return 'BAD fetch range';
+ }
+ if (defined($range) && (my $uid_min = $self->{uid_min})) {
+ my $uid_end = $uid_min + UID_BLOCK - 1;
+ $beg = $uid_min if $beg < $uid_min;
+ $end = $uid_end if $end > $uid_end;
+ }
+ [ $beg, $end, $$range_csv ];
+}
+
+sub refill_range ($$$) {
+ my ($self, $msgs, $range_info) = @_;
+ my ($beg, $end, $range_csv) = @$range_info;
+ if (scalar(@$msgs = @{$self->{ibx}->over->query_xover($beg, $end)})) {
+ $range_info->[0] = $msgs->[-1]->{num} + 1;
+ return;
+ }
+ return 'OK Fetch done' if !$range_csv;
+ my $next_range = range_step($self, \$range_csv);
+ return $next_range if !ref($next_range); # error
+ @$range_info = @$next_range;
+ undef; # keep looping
+}
+
sub uid_fetch_m { # long_response
- my ($self, $tag, $ibx, $beg, $end, $msgs, $want) = @_;
- if (!@$msgs) { # refill
- @$msgs = @{$ibx->over->query_xover($$beg, $end)};
- if (!@$msgs) {
- $self->write(\"$tag OK Fetch done\r\n");
+ 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;
}
- $$beg = $msgs->[-1]->{num} + 1;
}
- git_async_msg($ibx, $msgs->[0], \&uid_fetch_cb, \@_);
+ git_async_cat($self->{ibx}->git, $msgs->[0]->{blob},
+ \&uid_fetch_cb, \@_);
}
sub cmd_status ($$$;@) {
my ($self, $tag, $mailbox, @items) = @_;
- my $ibx = $self->{imapd}->{groups}->{$mailbox} or
+ my $ibx = $self->{imapd}->{mailboxes}->{lc $mailbox} or
return "$tag NO Mailbox doesn't exist: $mailbox\r\n";
return "$tag BAD no items\r\n" if !scalar(@items);
($items[0] !~ s/\A\(//s || $items[-1] !~ s/\)\z//s) and
} elsif ($it eq 'UIDNEXT') {
push(@it, ($max //= $mm->max // 0) + 1);
} elsif ($it eq 'UIDVALIDITY') {
- push(@it, $mm->created_at //
- return("$tag BAD UIDVALIDITY\r\n"));
+ push(@it, $ibx->{uidvalidity});
} else {
return "$tag BAD invalid item\r\n";
}
# request for hierarchy delimiter
$l = [ qq[* LIST (\\Noselect) "." ""\r\n] ];
} elsif ($refname ne '' || $wildcard ne '*') {
- $wildcard =~ s!([^a-z0-9_])!$patmap{$1} // "\Q$1"!eig;
+ $wildcard = lc $wildcard;
+ $wildcard =~ s!([^a-z0-9_])!$patmap{$1} // "\Q$1"!eg;
$l = [ grep(/ \Q$refname\E$wildcard\r\n\z/s, @$l) ];
}
\(join('', @$l, "$tag OK List done\r\n"));
}
sub fetch_common ($$$$) {
- my ($self, $tag, $range, $want) = @_;
+ my ($self, $tag, $range_csv, $want) = @_;
my $ibx = $self->{ibx} or return "$tag BAD No mailbox selected\r\n";
if ($want->[0] =~ s/\A\(//s) {
$want->[-1] =~ s/\)\z//s or return "$tag BAD no rparen\r\n";
[ $_, @{$partial{$_}} ]
} sort keys %partial ];
}
-
- my ($beg, $end);
- my $msgs = [];
- if ($range =~ /\A([0-9]+):([0-9]+)\z/s) {
- ($beg, $end) = ($1, $2);
- } elsif ($range =~ /\A([0-9]+):\*\z/s) {
- ($beg, $end) = ($1, $ibx->mm->max // 0);
- } elsif ($range =~ /\A[0-9]+\z/) {
- my $smsg = $ibx->over->get_art($range) or
- return "$tag OK Fetch done\r\n"; # really OK(!)
- push @$msgs, $smsg;
- ($beg, $end) = ($range, 0);
- } else {
- return "$tag BAD fetch range\r\n";
- }
- [ $tag, $ibx, \$beg, $end, $msgs, \%want ];
+ $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, @want) = @_;
- my $args = fetch_common($self, $tag, $range, \@want);
+ 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
}
sub seq_fetch_m { # long_response
- my ($self, $tag, $ibx, $beg, $end, $msgs, $want) = @_;
- if (!@$msgs) { # refill
- @$msgs = @{$ibx->over->query_xover($$beg, $end)};
- if (!@$msgs) {
- $self->write(\"$tag OK Fetch done\r\n");
+ 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;
}
- $$beg = $msgs->[-1]->{num} + 1;
}
my $seq = $want->{-seqno}++;
my $cur_num = $msgs->[0]->{num};
if ($cur_num == $seq) { # as expected
- git_async_msg($ibx, $msgs->[0], \&uid_fetch_cb, \@_);
+ 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($seq, $ibx);
+ 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
}
sub cmd_fetch ($$$;@) {
- my ($self, $tag, $range, @want) = @_;
- my $args = fetch_common($self, $tag, $range, \@want);
+ 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]}; # $$beg
+ $want->{-seqno} = $args->[2]->[0]; # $beg == $range_info->[0];
long_response($self, \&seq_fetch_m, @$args)
} : $args; # error
}
sub uid_search_all { # long_response
- my ($self, $tag, $ibx, $num) = @_;
- my $uids = $ibx->mm->ids_after($num);
+ my ($self, $tag, $num) = @_;
+ my $uids = $self->{ibx}->mm->ids_after($num);
if (scalar(@$uids)) {
$self->msg_more(join(' ', '', @$uids));
} else {
}
sub uid_search_uid_range { # long_response
- my ($self, $tag, $ibx, $beg, $end) = @_;
- my $uids = $ibx->mm->msg_range($beg, $end, 'num');
+ my ($self, $tag, $beg, $end) = @_;
+ my $uids = $self->{ibx}->mm->msg_range($beg, $end, 'num');
if (@$uids) {
$self->msg_more(join('', map { " $_->[0]" } @$uids));
} else {
if ($arg eq 'ALL' && !@rest) {
$self->msg_more('* SEARCH');
my $num = 0;
- long_response($self, \&uid_search_all, $tag, $ibx, \$num);
+ long_response($self, \&uid_search_all, $tag, \$num);
} elsif ($arg eq 'UID' && scalar(@rest) == 1) {
if ($rest[0] =~ /\A([0-9]+):([0-9]+|\*)\z/s) {
my ($beg, $end) = ($1, $2);
$end = $ibx->mm->max if $end eq '*';
$self->msg_more('* SEARCH');
long_response($self, \&uid_search_uid_range,
- $tag, $ibx, \$beg, $end);
+ $tag, \$beg, $end);
} elsif ($rest[0] =~ /\A[0-9]+\z/s) {
my $uid = $rest[0];
$uid = $ibx->over->get_art($uid) ? " $uid" : '';
sub event_step {
my ($self) = @_;
- return unless $self->flush_write && $self->{sock};
+ return unless $self->flush_write && $self->{sock} && !$self->{long_cb};
$self->update_idle_time;
# only read more requests if we've drained the write buffer,
# otherwise we can be buffering infinitely w/o backpressure
- my $rbuf = $self->{rbuf} // (\(my $x = ''));
- my $r = 1;
-
- if (index($$rbuf, "\n") < 0) {
- my $off = length($$rbuf);
- $r = $self->do_read($rbuf, LINE_MAX, $off) or return;
- }
- while ($r > 0 && $$rbuf =~ s/\A[ \t]*([^\n]*?)\r?\n//) {
- my $line = $1;
- return $self->close if $line =~ /[[:cntrl:]]/s;
- my $t0 = now();
- my $fd = fileno($self->{sock});
- $r = eval { process_line($self, $line) };
- my $pending = $self->{wbuf} ? ' pending' : '';
- out($self, "[$fd] %s - %0.6f$pending", $line, now() - $t0);
- }
+ my $rbuf = $self->{rbuf} // \(my $x = '');
+ my $line = index($$rbuf, "\n");
+ while ($line < 0) {
+ return $self->close if length($$rbuf) >= LINE_MAX;
+ $self->do_read($rbuf, LINE_MAX, length($$rbuf)) or return;
+ $line = index($$rbuf, "\n");
+ }
+ $line = substr($$rbuf, 0, $line + 1, '');
+ $line =~ s/\r?\n\z//s;
+ return $self->close if $line =~ /[[:cntrl:]]/s;
+ my $t0 = now();
+ my $fd = fileno($self->{sock});
+ my $r = eval { process_line($self, $line) };
+ my $pending = $self->{wbuf} ? ' pending' : '';
+ out($self, "[$fd] %s - %0.6f$pending - $r", $line, now() - $t0);
return $self->close if $r < 0;
- my $len = length($$rbuf);
- return $self->close if ($len >= LINE_MAX);
$self->rbuf_idle($rbuf);
$self->update_idle_time;
# maybe there's more pipelined data, or we'll have
# to register it for socket-readiness notifications
- $self->requeue unless $self->{wbuf};
+ $self->requeue unless $pending;
}
sub compressed { undef }