sub LINE_MAX () { 512 } # does RFC 3501 have a limit like RFC 977?
my %FETCH_NEED_BLOB = ( # for future optimization
- 'BODY.PEEK[HEADER]' => 1,
- 'BODY.PEEK[TEXT]' => 1,
- 'BODY.PEEK[]' => 1,
'BODY[HEADER]' => 1,
'BODY[TEXT]' => 1,
'BODY[]' => 1,
sub cmd_logout ($$) {
my ($self, $tag) = @_;
delete $self->{logged_in};
- $self->write(\"* BYE logging out\r\n$tag OK logout completed\r\n");
+ $self->write(\"* BYE logging out\r\n$tag OK Logout done\r\n");
$self->shutdn; # PublicInbox::DS::shutdn
undef;
}
sub cmd_capability ($$) {
my ($self, $tag) = @_;
- '* '.capa($self)."\r\n$tag OK\r\n";
+ '* '.capa($self)."\r\n$tag OK Capability done\r\n";
}
-sub cmd_noop ($$) { "$_[1] OK NOOP completed\r\n" }
+sub cmd_noop ($$) { "$_[1] OK Noop done\r\n" }
# called by PublicInbox::InboxIdle
sub on_inbox_unlock {
return "$tag BAD internal bug\r\n";
};
$ibx->unsubscribe_unlock(fileno($self->{sock}));
- "$idle_tag OK Idle completed\r\n";
+ "$idle_tag OK Idle done\r\n";
}
sub cmd_examine ($$$) {
$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 complete\r\n";
+ $ret .= "$tag OK [READ-ONLY] EXAMINE/SELECT done\r\n";
}
sub _esc ($) {
join('', @hold);
}
+sub dummy_message ($$) {
+ my ($seqno, $ibx) = @_;
+ 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
+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 uid_fetch_cb { # called by git->cat_async
my ($bref, $oid, $type, $size, $fetch_m_arg) = @_;
my ($self, undef, $ibx, undef, undef, $msgs, $want) = @$fetch_m_arg;
my $smsg = shift @$msgs or die 'BUG: no smsg';
- $smsg->{blob} eq $oid or die "BUG: $smsg->{blob} != $oid";
+ if (!defined($oid)) {
+ # it's possible to have TOCTOU if an admin runs
+ # public-inbox-(edit|purge), just move onto the next message
+ return unless defined $want->{-seqno};
+ $bref = dummy_message($smsg->{num}, $ibx);
+ } 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)
$want->{INTERNALDATE} and
$self->msg_more(' INTERNALDATE "'.$smsg->internaldate.'"');
$want->{FLAGS} and $self->msg_more(' FLAGS ()');
- for ('RFC822', 'BODY[]', 'BODY.PEEK[]') {
- next unless $want->{$_};
+ for ('RFC822', 'BODY[]') {
+ $want->{$_} or next;
$self->msg_more(" $_ {".length($$bref)."}\r\n");
$self->msg_more($$bref);
}
$want->{ENVELOPE} and
$self->msg_more(' ENVELOPE '.eml_envelope($eml));
- for my $f ('RFC822.HEADER', 'BODY[HEADER]', 'BODY.PEEK[HEADER]') {
- next unless $want->{$f};
- $self->msg_more(" $f {".length(${$eml->{hdr}})."}\r\n");
+ for ('RFC822.HEADER', 'BODY[HEADER]') {
+ $want->{$_} or next;
+ $self->msg_more(" $_ {".length(${$eml->{hdr}})."}\r\n");
$self->msg_more(${$eml->{hdr}});
}
- for my $f ('RFC822.TEXT', 'BODY[TEXT]') {
- next unless $want->{$f};
- $self->msg_more(" $f {".length($$bref)."}\r\n");
+ 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 = delete $want->{-partial}) {
+ if (my $partial = $want->{-partial}) {
partial_emit($self, $partial, $eml);
}
$self->msg_more(")\r\n");
}
return "$tag BAD no items\r\n" if !@it;
"* STATUS $mailbox (".join(' ', @it).")\r\n" .
- "$tag OK Status complete\r\n";
+ "$tag OK Status done\r\n";
}
my %patmap = ('*' => '.*', '%' => '[^\.]*');
$wildcard =~ s!([^a-z0-9_])!$patmap{$1} // "\Q$1"!eig;
$l = [ grep(/ \Q$refname\E$wildcard\r\n\z/s, @$l) ];
}
- \(join('', @$l, "$tag OK List complete\r\n"));
+ \(join('', @$l, "$tag OK List done\r\n"));
}
sub eml_index_offs_i { # PublicInbox::Eml::each_part callback
# recombine [ "BODY[1.HEADER.FIELDS", "(foo", "bar)]" ]
# back to: "BODY[1.HEADER.FIELDS (foo bar)]"
- return unless $att =~ /\ABODY(?:\.PEEK)?\[/s;
+ return unless $att =~ /\ABODY\[/s;
until (rindex($att, ']') >= 0) {
my $next = shift @$want or return;
$att .= ' ' . uc($next);
}
- if ($att =~ /\ABODY(?:\.PEEK)?\[
- ([0-9]+(?:\.[0-9]+)*)? # 1 - section_idx
- (?:\.(HEADER|MIME|TEXT))? # 2 - section_name
+ if ($att =~ /\ABODY\[([0-9]+(?:\.[0-9]+)*)? # 1 - section_idx
+ (?:\.(HEADER|MIME|TEXT))? # 2 - section_name
\](?:<([0-9]+)(?:\.([0-9]+))?>)?\z/sx) { # 3, 4
$partial->{$att} = [ \&partial_body, $1, $2, $3, $4 ];
- } elsif ($att =~ /\ABODY(?:\.PEEK)?\[
- (?:([0-9]+(?:\.[0-9]+)*)\.)? # 1 - section_idx
+ } elsif ($att =~ /\ABODY\[(?:([0-9]+(?:\.[0-9]+)*)\.)? # 1 - section_idx
(?:HEADER\.FIELDS(\.NOT)?)\x20 # 2
\(([A-Z0-9\-\x20]+)\) # 3 - hdrs
\](?:<([0-9]+)(?:\.([0-9]+))?>)?\z/sx) { # 4 5
sub partial_emit ($$$) {
my ($self, $partial, $eml) = @_;
- for my $k (sort keys %$partial) {
- my ($cb, @args) = @{$partial->{$k}};
+ for (@$partial) {
+ my ($k, $cb, @args) = @$_;
my ($offset, $len) = splice(@args, -2);
# $cb is partial_body|partial_hdr_get|partial_hdr_not
my $str = $cb->($eml, @args) // '';
}
}
-sub cmd_uid_fetch ($$$;@) {
- my ($self, $tag, $range, @want) = @_;
+sub fetch_common ($$$$) {
+ my ($self, $tag, $range, $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";
+ if ($want->[0] =~ s/\A\(//s) {
+ $want->[-1] =~ s/\)\z//s or return "$tag BAD no rparen\r\n";
}
my (%partial, %want);
- while (defined(my $att = shift @want)) {
+ while (defined(my $att = shift @$want)) {
$att = uc($att);
+ $att =~ s/\ABODY\.PEEK\[/BODY\[/; # we're read-only
my $x = $FETCH_ATT{$att};
if ($x) {
%want = (%want, %$x);
- } elsif (!partial_prepare(\%partial, \@want, $att)) {
+ } elsif (!partial_prepare(\%partial, $want, $att)) {
return "$tag BAD param: $att\r\n";
}
}
- $want{-partial} = \%partial if scalar keys %partial;
+
+ # stabilize partial order for consistency and ease-of-debugging:
+ if (scalar keys %partial) {
+ $want{-partial} = [ map {;
+ [ $_, @{$partial{$_}} ]
+ } sort keys %partial ];
+ }
+
my ($beg, $end);
my $msgs = [];
if ($range =~ /\A([0-9]+):([0-9]+)\z/s) {
} 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\r\n";
+ 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\r\n";
+ return "$tag BAD fetch range\r\n";
}
- long_response($self, \&uid_fetch_m, $tag, $ibx,
- \$beg, $end, $msgs, \%want);
+ [ $tag, $ibx, \$beg, $end, $msgs, \%want ];
+}
+
+sub cmd_uid_fetch ($$$;@) {
+ my ($self, $tag, $range, @want) = @_;
+ my $args = fetch_common($self, $tag, $range, \@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");
+ return;
+ }
+ $$beg = $msgs->[-1]->{num} + 1;
+ }
+ my $seq = $want->{-seqno}++;
+ my $cur_num = $msgs->[0]->{num};
+ if ($cur_num == $seq) { # as expected
+ my $git = $ibx->git;
+ $git->cat_async_begin; # TODO: actually make async
+ $git->cat_async($msgs->[0]->{blob}, \&uid_fetch_cb, \@_);
+ $git->cat_async_wait;
+ } 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);
+ uid_fetch_cb($bref, undef, undef, undef, \@_);
+ } else { # should not happen
+ die "BUG: cur_num=$cur_num < seq=$seq";
+ }
+ 1; # more messages on the way
+}
+
+sub cmd_fetch ($$$;@) {
+ my ($self, $tag, $range, @want) = @_;
+ my $args = fetch_common($self, $tag, $range, \@want);
+ ref($args) eq 'ARRAY' ? do {
+ my $want = $args->[-1];
+ $want->{-seqno} = ${$args->[2]}; # $$beg
+ long_response($self, \&seq_fetch_m, @$args)
+ } : $args; # error
}
sub uid_search_all { # long_response
if (scalar(@$uids)) {
$self->msg_more(join(' ', '', @$uids));
} else {
- $self->write(\"\r\n$tag OK\r\n");
+ $self->write(\"\r\n$tag OK Search done\r\n");
undef;
}
}
if (@$uids) {
$self->msg_more(join('', map { " $_->[0]" } @$uids));
} else {
- $self->write(\"\r\n$tag OK\r\n");
+ $self->write(\"\r\n$tag OK Search done\r\n");
undef;
}
}
} elsif ($rest[0] =~ /\A[0-9]+\z/s) {
my $uid = $rest[0];
$uid = $ibx->over->get_art($uid) ? " $uid" : '';
- "* SEARCH$uid\r\n$tag OK\r\n";
+ "* SEARCH$uid\r\n$tag OK Search done\r\n";
} else {
- "$tag BAD\r\n";
+ "$tag BAD Error\r\n";
}
} else {
- "$tag BAD\r\n";
+ "$tag BAD Error\r\n";
}
}