lib/PublicInbox/IMAP.pm

   1 # Copyright (C) 2020 all contributors <meta@public-inbox.org>
   2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
   3 #
   4 # Each instance of this represents an IMAP client connected to
   5 # public-inbox-imapd.  Much of this was taken from NNTP, but
   6 # further refined while experimenting on future ideas to handle
   7 # slow storage.
   8 #
   9 # data notes:
  10 #
  11 # * NNTP article numbers are UIDs, mm->created_at is UIDVALIDITY
  12 #
  13 # * public-inboxes are sliced into mailboxes of 50K messages
  14 #   to not overload MUAs: $NEWSGROUP_NAME.$SLICE_INDEX
  15 #   Slices are similar in concept to v2 "epochs".  Epochs
  16 #   are for the limitations of git clients, while slices are
  17 #   for the limitations of IMAP clients.
  18 #
  19 # * We also take advantage of slices being only 50K to store
  20 #   "UID offset" to message sequence number (MSN) mapping
  21 #   as a 50K uint16_t array (via pack("S*", ...)).  "UID offset"
  22 #   is the offset from {uid_base} which determines the start of
  23 #   the mailbox slice.
  24 #
  25 # fields:
  26 # imapd: PublicInbox::IMAPD ref
  27 # ibx: PublicInbox::Inbox ref
  28 # long_cb: long_response private data
  29 # uid_base: base UID for mailbox slice (0-based)
  30 # -login_tag: IMAP TAG for LOGIN
  31 # -idle_tag: IMAP response tag for IDLE
  32 # uo2m: UID-to-MSN mapping
  33 package PublicInbox::IMAP;
  34 use strict;
  35 use parent qw(PublicInbox::DS);
  36 use PublicInbox::Eml;
  37 use PublicInbox::EmlContentFoo qw(parse_content_disposition);
  38 use PublicInbox::DS qw(now);
  39 use PublicInbox::Syscall qw(EPOLLIN EPOLLONESHOT);
  40 use PublicInbox::GitAsyncCat;
  41 use Text::ParseWords qw(parse_line);
  42 use Errno qw(EAGAIN);
  43 use PublicInbox::IMAPsearchqp;
  44
  45 my $Address;
  46 for my $mod (qw(Email::Address::XS Mail::Address)) {
  47         eval "require $mod" or next;
  48         $Address = $mod and last;
  49 }
  50 die "neither Email::Address::XS nor Mail::Address loaded: $@" if !$Address;
  51
  52 sub LINE_MAX () { 8000 } # RFC 2683 3.2.1.5
  53
  54 # Changing UID_SLICE will cause grief for clients which cache.
  55 # This also needs to be <64K: we pack it into a uint16_t
  56 # for long_response UID (offset) => MSN mappings
  57 sub UID_SLICE () { 50_000 }
  58
  59 # these values area also used for sorting
  60 sub NEED_SMSG () { 1 }
  61 sub NEED_BLOB () { NEED_SMSG|2 }
  62 sub CRLF_BREF () { 4 }
  63 sub EML_HDR () { 8 }
  64 sub CRLF_HDR () { 16 }
  65 sub EML_BDY () { 32 }
  66 sub CRLF_BDY () { 64 }
  67 my $OP_EML_NEW = [ EML_HDR - 1, \&op_eml_new ];
  68 my $OP_CRLF_BREF = [ CRLF_BREF, \&op_crlf_bref ];
  69 my $OP_CRLF_HDR = [ CRLF_HDR, \&op_crlf_hdr ];
  70 my $OP_CRLF_BDY = [ CRLF_BDY, \&op_crlf_bdy ];
  71
  72 my %FETCH_NEED = (
  73         'BODY[HEADER]' => [ NEED_BLOB|EML_HDR|CRLF_HDR, \&emit_rfc822_header ],
  74         'BODY[TEXT]' => [ NEED_BLOB|EML_BDY|CRLF_BDY, \&emit_rfc822_text ],
  75         'BODY[]' => [ NEED_BLOB|CRLF_BREF, \&emit_rfc822 ],
  76         'RFC822.HEADER' => [ NEED_BLOB|EML_HDR|CRLF_HDR, \&emit_rfc822_header ],
  77         'RFC822.TEXT' => [ NEED_BLOB|EML_BDY|CRLF_BDY, \&emit_rfc822_text ],
  78         'RFC822.SIZE' => [ NEED_SMSG, \&emit_rfc822_size ],
  79         RFC822 => [ NEED_BLOB|CRLF_BREF, \&emit_rfc822 ],
  80         BODY => [ NEED_BLOB|EML_HDR|EML_BDY, \&emit_body ],
  81         BODYSTRUCTURE => [ NEED_BLOB|EML_HDR|EML_BDY, \&emit_bodystructure ],
  82         ENVELOPE => [ NEED_BLOB|EML_HDR, \&emit_envelope ],
  83         FLAGS => [ 0, \&emit_flags ],
  84         INTERNALDATE => [ NEED_SMSG, \&emit_internaldate ],
  85 );
  86 my %FETCH_ATT = map { $_ => [ $_ ] } keys %FETCH_NEED;
  87
  88 # aliases (RFC 3501 section 6.4.5)
  89 $FETCH_ATT{FAST} = [ qw(FLAGS INTERNALDATE RFC822.SIZE) ];
  90 $FETCH_ATT{ALL} = [ @{$FETCH_ATT{FAST}}, 'ENVELOPE' ];
  91 $FETCH_ATT{FULL} = [ @{$FETCH_ATT{ALL}}, 'BODY' ];
  92
  93 for my $att (keys %FETCH_ATT) {
  94         my %h = map { $_ => $FETCH_NEED{$_} } @{$FETCH_ATT{$att}};
  95         $FETCH_ATT{$att} = \%h;
  96 }
  97 undef %FETCH_NEED;
  98
  99 my $valid_range = '[0-9]+|[0-9]+:[0-9]+|[0-9]+:\*';
 100 $valid_range = qr/\A(?:$valid_range)(?:,(?:$valid_range))*\z/;
 101
 102 # RFC 3501 5.4. Autologout Timer needs to be >= 30min
 103 $PublicInbox::DS::EXPTIME = 60 * 30;
 104
 105 sub greet ($) {
 106         my ($self) = @_;
 107         my $capa = capa($self);
 108         $self->write(\"* OK [$capa] public-inbox-imapd ready\r\n");
 109 }
 110
 111 sub new ($$$) {
 112         my ($class, $sock, $imapd) = @_;
 113         my $self = bless { imapd => $imapd }, 'PublicInbox::IMAP_preauth';
 114         my $ev = EPOLLIN;
 115         my $wbuf;
 116         if ($sock->can('accept_SSL') && !$sock->accept_SSL) {
 117                 return CORE::close($sock) if $! != EAGAIN;
 118                 $ev = PublicInbox::TLS::epollbit();
 119                 $wbuf = [ \&PublicInbox::DS::accept_tls_step, \&greet ];
 120         }
 121         $self->SUPER::new($sock, $ev | EPOLLONESHOT);
 122         if ($wbuf) {
 123                 $self->{wbuf} = $wbuf;
 124         } else {
 125                 greet($self);
 126         }
 127         $self->update_idle_time;
 128         $self;
 129 }
 130
 131 sub logged_in { 1 }
 132
 133 sub capa ($) {
 134         my ($self) = @_;
 135
 136         # dovecot advertises IDLE pre-login; perhaps because some clients
 137         # depend on it, so we'll do the same
 138         my $capa = 'CAPABILITY IMAP4rev1 IDLE';
 139         if ($self->logged_in) {
 140                 $capa .= ' COMPRESS=DEFLATE';
 141         } else {
 142                 if (!($self->{sock} // $self)->can('accept_SSL') &&
 143                         $self->{imapd}->{accept_tls}) {
 144                         $capa .= ' STARTTLS';
 145                 }
 146                 $capa .= ' AUTH=ANONYMOUS';
 147         }
 148 }
 149
 150 sub login_success ($$) {
 151         my ($self, $tag) = @_;
 152         bless $self, 'PublicInbox::IMAP';
 153         my $capa = capa($self);
 154         "$tag OK [$capa] Logged in\r\n";
 155 }
 156
 157 sub auth_challenge_ok ($) {
 158         my ($self) = @_;
 159         my $tag = delete($self->{-login_tag}) or return;
 160         login_success($self, $tag);
 161 }
 162
 163 sub cmd_login ($$$$) {
 164         my ($self, $tag) = @_; # ignore ($user, $password) = ($_[2], $_[3])
 165         login_success($self, $tag);
 166 }
 167
 168 sub cmd_close ($$) {
 169         my ($self, $tag) = @_;
 170         delete @$self{qw(uid_base uo2m)};
 171         delete $self->{ibx} ? "$tag OK Close done\r\n"
 172                                 : "$tag BAD No mailbox\r\n";
 173 }
 174
 175 sub cmd_logout ($$) {
 176         my ($self, $tag) = @_;
 177         delete $self->{-idle_tag};
 178         $self->write(\"* BYE logging out\r\n$tag OK Logout done\r\n");
 179         $self->shutdn; # PublicInbox::DS::shutdn
 180         undef;
 181 }
 182
 183 sub cmd_authenticate ($$$) {
 184         my ($self, $tag) = @_; # $method = $_[2], should be "ANONYMOUS"
 185         $self->{-login_tag} = $tag;
 186         "+\r\n"; # challenge
 187 }
 188
 189 sub cmd_capability ($$) {
 190         my ($self, $tag) = @_;
 191         '* '.capa($self)."\r\n$tag OK Capability done\r\n";
 192 }
 193
 194 # uo2m: UID Offset to MSN, this is an arrayref by default,
 195 # but uo2m_hibernate can compact and deduplicate it
 196 sub uo2m_ary_new ($;$) {
 197         my ($self, $exists) = @_;
 198         my $base = $self->{uid_base};
 199         my $uids = $self->{ibx}->over->uid_range($base + 1, $base + UID_SLICE);
 200
 201         # convert UIDs to offsets from {base}
 202         my @tmp; # [$UID_OFFSET] => $MSN
 203         my $msn = 0;
 204         ++$base;
 205         $tmp[$_ - $base] = ++$msn for @$uids;
 206         $$exists = $msn if $exists;
 207         \@tmp;
 208 }
 209
 210 # changes UID-offset-to-MSN mapping into a deduplicated scalar:
 211 # uint16_t uo2m[UID_SLICE].
 212 # May be swapped out for idle clients if THP is disabled.
 213 sub uo2m_hibernate ($) {
 214         my ($self) = @_;
 215         ref(my $uo2m = $self->{uo2m}) or return;
 216         my %dedupe = ( uo2m_pack($uo2m) => undef );
 217         $self->{uo2m} = (keys(%dedupe))[0];
 218         undef;
 219 }
 220
 221 sub uo2m_last_uid ($) {
 222         my ($self) = @_;
 223         defined(my $uo2m = $self->{uo2m}) or die 'BUG: uo2m_last_uid w/o {uo2m}';
 224         (ref($uo2m) ? @$uo2m : (length($uo2m) >> 1)) + $self->{uid_base};
 225 }
 226
 227 sub uo2m_pack ($) {
 228         # $_[0] is an arrayref of MSNs, it may have undef gaps if there
 229         # are gaps in the corresponding UIDs: [ msn1, msn2, undef, msn3 ]
 230         no warnings 'uninitialized';
 231         pack('S*', @{$_[0]});
 232 }
 233
 234 # extend {uo2m} to account for new messages which arrived since
 235 # {uo2m} was created.
 236 sub uo2m_extend ($$;$) {
 237         my ($self, $new_uid_max) = @_;
 238         defined(my $uo2m = $self->{uo2m}) or
 239                 return($self->{uo2m} = uo2m_ary_new($self));
 240         my $beg = uo2m_last_uid($self); # last UID we've learned
 241         return $uo2m if $beg >= $new_uid_max; # fast path
 242
 243         # need to extend the current range:
 244         my $base = $self->{uid_base};
 245         ++$beg;
 246         my $uids = $self->{ibx}->over->uid_range($beg, $base + UID_SLICE);
 247         return $uo2m if !scalar(@$uids);
 248         my @tmp; # [$UID_OFFSET] => $MSN
 249         my $write_method = $_[2] // 'msg_more';
 250         if (ref($uo2m)) {
 251                 my $msn = $uo2m->[-1];
 252                 $tmp[$_ - $beg] = ++$msn for @$uids;
 253                 $self->$write_method("* $msn EXISTS\r\n");
 254                 push @$uo2m, @tmp;
 255                 $uo2m;
 256         } else {
 257                 my $msn = unpack('S', substr($uo2m, -2, 2));
 258                 $tmp[$_ - $beg] = ++$msn for @$uids;
 259                 $self->$write_method("* $msn EXISTS\r\n");
 260                 $uo2m .= uo2m_pack(\@tmp);
 261                 my %dedupe = ($uo2m => undef);
 262                 $self->{uo2m} = (keys %dedupe)[0];
 263         }
 264 }
 265
 266 sub cmd_noop ($$) {
 267         my ($self, $tag) = @_;
 268         defined($self->{uid_base}) and
 269                 uo2m_extend($self, $self->{uid_base} + UID_SLICE);
 270         \"$tag OK Noop done\r\n";
 271 }
 272
 273 # the flexible version which works on scalars and array refs.
 274 # Must call uo2m_extend before this
 275 sub uid2msn ($$) {
 276         my ($self, $uid) = @_;
 277         my $uo2m = $self->{uo2m};
 278         my $off = $uid - $self->{uid_base} - 1;
 279         ref($uo2m) ? $uo2m->[$off] : unpack('S', substr($uo2m, $off << 1, 2));
 280 }
 281
 282 # returns an arrayref of UIDs, so MSNs can be translated to UIDs via:
 283 # $msn2uid->[$MSN-1] => $UID.  The result of this is always ephemeral
 284 # and does not live beyond the event loop.
 285 sub msn2uid ($) {
 286         my ($self) = @_;
 287         my $base = $self->{uid_base};
 288         my $uo2m = uo2m_extend($self, $base + UID_SLICE);
 289         $uo2m = [ unpack('S*', $uo2m) ] if !ref($uo2m);
 290
 291         my $uo = 0;
 292         my @msn2uid;
 293         for my $msn (@$uo2m) {
 294                 ++$uo;
 295                 $msn2uid[$msn - 1] = $uo + $base if $msn;
 296         }
 297         \@msn2uid;
 298 }
 299
 300 # converts a set of message sequence numbers in requests to UIDs:
 301 sub msn_to_uid_range ($$) {
 302         my $msn2uid = $_[0];
 303         $_[1] =~ s!([0-9]+)!$msn2uid->[$1 - 1] // ($msn2uid->[-1] // 0 + 1)!sge;
 304 }
 305
 306 # called by PublicInbox::InboxIdle
 307 sub on_inbox_unlock {
 308         my ($self, $ibx) = @_;
 309         my $uid_end = $self->{uid_base} + UID_SLICE;
 310         uo2m_extend($self, $uid_end, 'write');
 311         my $new = uo2m_last_uid($self);
 312         if ($new == $uid_end) { # max exceeded $uid_end
 313                 # continue idling w/o inotify
 314                 my $sock = $self->{sock} or return;
 315                 $ibx->unsubscribe_unlock(fileno($sock));
 316         }
 317 }
 318
 319 # called every X minute(s) or so by PublicInbox::DS::later
 320 my $IDLERS = {};
 321 my $idle_timer;
 322 sub idle_tick_all {
 323         my $old = $IDLERS;
 324         $IDLERS = {};
 325         for my $i (values %$old) {
 326                 next if ($i->{wbuf} || !exists($i->{-idle_tag}));
 327                 $i->update_idle_time or next;
 328                 $IDLERS->{fileno($i->{sock})} = $i;
 329                 $i->write(\"* OK Still here\r\n");
 330         }
 331         $idle_timer = scalar keys %$IDLERS ?
 332                         PublicInbox::DS::later(\&idle_tick_all) : undef;
 333 }
 334
 335 sub cmd_idle ($$) {
 336         my ($self, $tag) = @_;
 337         # IDLE seems allowed by dovecot w/o a mailbox selected *shrug*
 338         my $ibx = $self->{ibx} or return "$tag BAD no mailbox selected\r\n";
 339         my $uid_end = $self->{uid_base} + UID_SLICE;
 340         uo2m_extend($self, $uid_end);
 341         my $sock = $self->{sock} or return;
 342         my $fd = fileno($sock);
 343         $self->{-idle_tag} = $tag;
 344         # only do inotify on most recent slice
 345         if ($ibx->over->max < $uid_end) {
 346                 $ibx->subscribe_unlock($fd, $self);
 347                 $self->{imapd}->idler_start;
 348         }
 349         $idle_timer //= PublicInbox::DS::later(\&idle_tick_all);
 350         $IDLERS->{$fd} = $self;
 351         \"+ idling\r\n"
 352 }
 353
 354 sub stop_idle ($$) {
 355         my ($self, $ibx) = @_;
 356         my $sock = $self->{sock} or return;
 357         my $fd = fileno($sock);
 358         delete $IDLERS->{$fd};
 359         $ibx->unsubscribe_unlock($fd);
 360 }
 361
 362 sub idle_done ($$) {
 363         my ($self, $tag) = @_; # $tag is "DONE" (case-insensitive)
 364         defined(my $idle_tag = delete $self->{-idle_tag}) or
 365                 return "$tag BAD not idle\r\n";
 366         my $ibx = $self->{ibx} or do {
 367                 warn "BUG: idle_tag set w/o inbox";
 368                 return "$tag BAD internal bug\r\n";
 369         };
 370         stop_idle($self, $ibx);
 371         "$idle_tag OK Idle done\r\n";
 372 }
 373
 374 sub ensure_slices_exist ($$$) {
 375         my ($imapd, $ibx, $max) = @_;
 376         defined(my $mb_top = $ibx->{newsgroup}) or return;
 377         my $mailboxes = $imapd->{mailboxes};
 378         my @created;
 379         for (my $i = int($max/UID_SLICE); $i >= 0; --$i) {
 380                 my $sub_mailbox = "$mb_top.$i";
 381                 last if exists $mailboxes->{$sub_mailbox};
 382                 $mailboxes->{$sub_mailbox} = $ibx;
 383                 $sub_mailbox =~ s/\Ainbox\./INBOX./i; # more familiar to users
 384                 push @created, $sub_mailbox;
 385         }
 386         return unless @created;
 387         my $l = $imapd->{inboxlist} or return;
 388         push @$l, map { qq[* LIST (\\HasNoChildren) "." $_\r\n] } @created;
 389 }
 390
 391 sub inbox_lookup ($$;$) {
 392         my ($self, $mailbox, $examine) = @_;
 393         my ($ibx, $exists, $uidmax, $uid_base) = (undef, 0, 0, 0);
 394         $mailbox = lc $mailbox;
 395         $ibx = $self->{imapd}->{mailboxes}->{$mailbox} or return;
 396         my $over = $ibx->over;
 397         if ($over != $ibx) { # not a dummy
 398                 $mailbox =~ /\.([0-9]+)\z/ or
 399                                 die "BUG: unexpected dummy mailbox: $mailbox\n";
 400                 $uid_base = $1 * UID_SLICE;
 401
 402                 # ->num_highwater caches for writers, so use ->meta_accessor
 403                 $uidmax = $ibx->mm->meta_accessor('num_highwater') // 0;
 404                 if ($examine) {
 405                         $self->{uid_base} = $uid_base;
 406                         $self->{ibx} = $ibx;
 407                         $self->{uo2m} = uo2m_ary_new($self, \$exists);
 408                 } else {
 409                         $exists = $over->imap_exists;
 410                 }
 411                 ensure_slices_exist($self->{imapd}, $ibx, $over->max);
 412         } else {
 413                 if ($examine) {
 414                         $self->{uid_base} = $uid_base;
 415                         $self->{ibx} = $ibx;
 416                         delete $self->{uo2m};
 417                 }
 418                 # if "INBOX.foo.bar" is selected and "INBOX.foo.bar.0",
 419                 # check for new UID ranges (e.g. "INBOX.foo.bar.1")
 420                 if (my $z = $self->{imapd}->{mailboxes}->{"$mailbox.0"}) {
 421                         ensure_slices_exist($self->{imapd}, $z, $z->over->max);
 422                 }
 423         }
 424         ($ibx, $exists, $uidmax + 1, $uid_base);
 425 }
 426
 427 sub cmd_examine ($$$) {
 428         my ($self, $tag, $mailbox) = @_;
 429         # XXX: do we need this? RFC 5162/7162
 430         my $ret = $self->{ibx} ? "* OK [CLOSED] previous closed\r\n" : '';
 431         my ($ibx, $exists, $uidnext, $base) = inbox_lookup($self, $mailbox, 1);
 432         return "$tag NO Mailbox doesn't exist: $mailbox\r\n" if !$ibx;
 433         $ret .= <<EOF;
 434 * $exists EXISTS\r
 435 * $exists RECENT\r
 436 * FLAGS (\\Seen)\r
 437 * OK [PERMANENTFLAGS ()] Read-only mailbox\r
 438 * OK [UNSEEN $exists]\r
 439 * OK [UIDNEXT $uidnext]\r
 440 * OK [UIDVALIDITY $ibx->{uidvalidity}]\r
 441 $tag OK [READ-ONLY] EXAMINE/SELECT done\r
 442 EOF
 443 }
 444
 445 sub _esc ($) {
 446         my ($v) = @_;
 447         if (!defined($v)) {
 448                 'NIL';
 449         } elsif ($v =~ /[{"\r\n%*\\\[]/) { # literal string
 450                 '{' . length($v) . "}\r\n" . $v;
 451         } else { # quoted string
 452                 qq{"$v"}
 453         }
 454 }
 455
 456 sub addr_envelope ($$;$) {
 457         my ($eml, $x, $y) = @_;
 458         my $v = $eml->header_raw($x) //
 459                 ($y ? $eml->header_raw($y) : undef) // return 'NIL';
 460
 461         my @x = $Address->parse($v) or return 'NIL';
 462         '(' . join('',
 463                 map { '(' . join(' ',
 464                                 _esc($_->name), 'NIL',
 465                                 _esc($_->user), _esc($_->host)
 466                         ) . ')'
 467                 } @x) .
 468         ')';
 469 }
 470
 471 sub eml_envelope ($) {
 472         my ($eml) = @_;
 473         '(' . join(' ',
 474                 _esc($eml->header_raw('Date')),
 475                 _esc($eml->header_raw('Subject')),
 476                 addr_envelope($eml, 'From'),
 477                 addr_envelope($eml, 'Sender', 'From'),
 478                 addr_envelope($eml, 'Reply-To', 'From'),
 479                 addr_envelope($eml, 'To'),
 480                 addr_envelope($eml, 'Cc'),
 481                 addr_envelope($eml, 'Bcc'),
 482                 _esc($eml->header_raw('In-Reply-To')),
 483                 _esc($eml->header_raw('Message-ID')),
 484         ) . ')';
 485 }
 486
 487 sub _esc_hash ($) {
 488         my ($hash) = @_;
 489         if ($hash && scalar keys %$hash) {
 490                 $hash = [ %$hash ]; # flatten hash into 1-dimensional array
 491                 '(' . join(' ', map { _esc($_) } @$hash) . ')';
 492         } else {
 493                 'NIL';
 494         }
 495 }
 496
 497 sub body_disposition ($) {
 498         my ($eml) = @_;
 499         my $cd = $eml->header_raw('Content-Disposition') or return 'NIL';
 500         $cd = parse_content_disposition($cd);
 501         my $buf = '('._esc($cd->{type});
 502         $buf .= ' ' . _esc_hash(delete $cd->{attributes});
 503         $buf .= ')';
 504 }
 505
 506 sub body_leaf ($$;$) {
 507         my ($eml, $structure, $hold) = @_;
 508         my $buf = '';
 509         $eml->{is_submsg} and # parent was a message/(rfc822|news|global)
 510                 $buf .= eml_envelope($eml). ' ';
 511         my $ct = $eml->ct;
 512         $buf .= '('._esc($ct->{type}).' ';
 513         $buf .= _esc($ct->{subtype});
 514         $buf .= ' ' . _esc_hash(delete $ct->{attributes});
 515         $buf .= ' ' . _esc($eml->header_raw('Content-ID'));
 516         $buf .= ' ' . _esc($eml->header_raw('Content-Description'));
 517         my $cte = $eml->header_raw('Content-Transfer-Encoding') // '7bit';
 518         $buf .= ' ' . _esc($cte);
 519         $buf .= ' ' . $eml->{imap_body_len};
 520         $buf .= ' '.($eml->body_raw =~ tr/\n/\n/) if lc($ct->{type}) eq 'text';
 521
 522         # for message/(rfc822|global|news), $hold[0] should have envelope
 523         $buf .= ' ' . (@$hold ? join('', @$hold) : 'NIL') if $hold;
 524
 525         if ($structure) {
 526                 $buf .= ' '._esc($eml->header_raw('Content-MD5'));
 527                 $buf .= ' '. body_disposition($eml);
 528                 $buf .= ' '._esc($eml->header_raw('Content-Language'));
 529                 $buf .= ' '._esc($eml->header_raw('Content-Location'));
 530         }
 531         $buf .= ')';
 532 }
 533
 534 sub body_parent ($$$) {
 535         my ($eml, $structure, $hold) = @_;
 536         my $ct = $eml->ct;
 537         my $type = lc($ct->{type});
 538         if ($type eq 'multipart') {
 539                 my $buf = '(';
 540                 $buf .= @$hold ? join('', @$hold) : 'NIL';
 541                 $buf .= ' '._esc($ct->{subtype});
 542                 if ($structure) {
 543                         $buf .= ' '._esc_hash(delete $ct->{attributes});
 544                         $buf .= ' '.body_disposition($eml);
 545                         $buf .= ' '._esc($eml->header_raw('Content-Language'));
 546                         $buf .= ' '._esc($eml->header_raw('Content-Location'));
 547                 }
 548                 $buf .= ')';
 549                 @$hold = ($buf);
 550         } else { # message/(rfc822|global|news)
 551                 @$hold = (body_leaf($eml, $structure, $hold));
 552         }
 553 }
 554
 555 # this is gross, but we need to process the parent part AFTER
 556 # the child parts are done
 557 sub bodystructure_prep {
 558         my ($p, $q) = @_;
 559         my ($eml, $depth) = @$p; # ignore idx
 560         # set length here, as $eml->{bdy} gets deleted for message/rfc822
 561         $eml->{imap_body_len} = length($eml->body_raw);
 562         push @$q, $eml, $depth;
 563 }
 564
 565 # for FETCH BODY and FETCH BODYSTRUCTURE
 566 sub fetch_body ($;$) {
 567         my ($eml, $structure) = @_;
 568         my @q;
 569         $eml->each_part(\&bodystructure_prep, \@q, 0, 1);
 570         my $cur_depth = 0;
 571         my @hold;
 572         do {
 573                 my ($part, $depth) = splice(@q, -2);
 574                 my $is_mp_parent = $depth == ($cur_depth - 1);
 575                 $cur_depth = $depth;
 576
 577                 if ($is_mp_parent) {
 578                         body_parent($part, $structure, \@hold);
 579                 } else {
 580                         unshift @hold, body_leaf($part, $structure);
 581                 }
 582         } while (@q);
 583         join('', @hold);
 584 }
 585
 586 sub requeue_once ($) {
 587         my ($self) = @_;
 588         # COMPRESS users all share the same DEFLATE context.
 589         # Flush it here to ensure clients don't see
 590         # each other's data
 591         $self->zflush;
 592
 593         # no recursion, schedule another call ASAP,
 594         # but only after all pending writes are done.
 595         # autovivify wbuf:
 596         my $new_size = push(@{$self->{wbuf}}, \&long_step);
 597
 598         # wbuf may be populated by $cb, no need to rearm if so:
 599         $self->requeue if $new_size == 1;
 600 }
 601
 602 sub fetch_run_ops {
 603         my ($self, $smsg, $bref, $ops, $partial) = @_;
 604         my $uid = $smsg->{num};
 605         $self->msg_more('* '.uid2msn($self, $uid)." FETCH (UID $uid");
 606         my ($eml, $k);
 607         for (my $i = 0; $i < @$ops;) {
 608                 $k = $ops->[$i++];
 609                 $ops->[$i++]->($self, $k, $smsg, $bref, $eml);
 610         }
 611         partial_emit($self, $partial, $eml) if $partial;
 612         $self->msg_more(")\r\n");
 613 }
 614
 615 sub fetch_blob_cb { # called by git->cat_async via git_async_cat
 616         my ($bref, $oid, $type, $size, $fetch_arg) = @_;
 617         my ($self, undef, $msgs, $range_info, $ops, $partial) = @$fetch_arg;
 618         my $ibx = $self->{ibx} or return $self->close; # client disconnected
 619         my $smsg = shift @$msgs or die 'BUG: no smsg';
 620         if (!defined($oid)) {
 621                 # it's possible to have TOCTOU if an admin runs
 622                 # public-inbox-(edit|purge), just move onto the next message
 623                 warn "E: $smsg->{blob} missing in $ibx->{inboxdir}\n";
 624                 return requeue_once($self);
 625         } else {
 626                 $smsg->{blob} eq $oid or die "BUG: $smsg->{blob} != $oid";
 627         }
 628         my $pre;
 629         if (!$self->{wbuf} && (my $nxt = $msgs->[0])) {
 630                 $pre = $ibx->git->async_prefetch($nxt->{blob},
 631                                                 \&fetch_blob_cb, $fetch_arg);
 632         }
 633         fetch_run_ops($self, $smsg, $bref, $ops, $partial);
 634         $pre ? $self->zflush : requeue_once($self);
 635 }
 636
 637 sub emit_rfc822 {
 638         my ($self, $k, undef, $bref) = @_;
 639         $self->msg_more(" $k {" . length($$bref)."}\r\n");
 640         $self->msg_more($$bref);
 641 }
 642
 643 # Mail::IMAPClient::message_string cares about this by default,
 644 # (->Ignoresizeerrors attribute).  Admins are encouraged to
 645 # --reindex for IMAP support, anyways.
 646 sub emit_rfc822_size {
 647         my ($self, $k, $smsg) = @_;
 648         $self->msg_more(' RFC822.SIZE ' . $smsg->{bytes});
 649 }
 650
 651 sub emit_internaldate {
 652         my ($self, undef, $smsg) = @_;
 653         $self->msg_more(' INTERNALDATE "'.$smsg->internaldate.'"');
 654 }
 655
 656 sub emit_flags { $_[0]->msg_more(' FLAGS ()') }
 657
 658 sub emit_envelope {
 659         my ($self, undef, undef, undef, $eml) = @_;
 660         $self->msg_more(' ENVELOPE '.eml_envelope($eml));
 661 }
 662
 663 sub emit_rfc822_header {
 664         my ($self, $k, undef, undef, $eml) = @_;
 665         $self->msg_more(" $k {".length(${$eml->{hdr}})."}\r\n");
 666         $self->msg_more(${$eml->{hdr}});
 667 }
 668
 669 # n.b. this is sorted to be after any emit_eml_new ops
 670 sub emit_rfc822_text {
 671         my ($self, $k, undef, $bref) = @_;
 672         $self->msg_more(" $k {".length($$bref)."}\r\n");
 673         $self->msg_more($$bref);
 674 }
 675
 676 sub emit_bodystructure {
 677         my ($self, undef, undef, undef, $eml) = @_;
 678         $self->msg_more(' BODYSTRUCTURE '.fetch_body($eml, 1));
 679 }
 680
 681 sub emit_body {
 682         my ($self, undef, undef, undef, $eml) = @_;
 683         $self->msg_more(' BODY '.fetch_body($eml));
 684 }
 685
 686 # set $eml once ($_[4] == $eml, $_[3] == $bref)
 687 sub op_eml_new { $_[4] = PublicInbox::Eml->new($_[3]) }
 688
 689 # s/From / fixes old bug from import (pre-a0c07cba0e5d8b6a)
 690 sub to_crlf_full {
 691         ${$_[0]} =~ s/(?<!\r)\n/\r\n/sg;
 692         ${$_[0]} =~ s/\A[\r\n]*From [^\r\n]*\r\n//s;
 693 }
 694
 695 sub op_crlf_bref { to_crlf_full($_[3]) }
 696
 697 sub op_crlf_hdr { to_crlf_full($_[4]->{hdr}) }
 698
 699 sub op_crlf_bdy { ${$_[4]->{bdy}} =~ s/(?<!\r)\n/\r\n/sg if $_[4]->{bdy} }
 700
 701 sub uid_clamp ($$$) {
 702         my ($self, $beg, $end) = @_;
 703         my $uid_min = $self->{uid_base} + 1;
 704         my $uid_end = $uid_min + UID_SLICE - 1;
 705         $$beg = $uid_min if $$beg < $uid_min;
 706         $$end = $uid_end if $$end > $uid_end;
 707 }
 708
 709 sub range_step ($$) {
 710         my ($self, $range_csv) = @_;
 711         my ($beg, $end, $range);
 712         if ($$range_csv =~ s/\A([^,]+),//) {
 713                 $range = $1;
 714         } else {
 715                 $range = $$range_csv;
 716                 $$range_csv = undef;
 717         }
 718         my $uid_base = $self->{uid_base};
 719         my $uid_end = $uid_base + UID_SLICE;
 720         if ($range =~ /\A([0-9]+):([0-9]+)\z/) {
 721                 ($beg, $end) = ($1 + 0, $2 + 0);
 722                 uid_clamp($self, \$beg, \$end);
 723         } elsif ($range =~ /\A([0-9]+):\*\z/) {
 724                 $beg = $1 + 0;
 725                 $end = $self->{ibx}->over->max;
 726                 $end = $uid_end if $end > $uid_end;
 727                 $beg = $end if $beg > $end;
 728                 uid_clamp($self, \$beg, \$end);
 729         } elsif ($range =~ /\A[0-9]+\z/) {
 730                 $beg = $end = $range + 0;
 731                 # just let the caller do an out-of-range query if a single
 732                 # UID is out-of-range
 733                 ++$beg if ($beg <= $uid_base || $end > $uid_end);
 734         } else {
 735                 return 'BAD fetch range';
 736         }
 737         [ $beg, $end, $$range_csv ];
 738 }
 739
 740 sub refill_range ($$$) {
 741         my ($self, $msgs, $range_info) = @_;
 742         my ($beg, $end, $range_csv) = @$range_info;
 743         if (scalar(@$msgs = @{$self->{ibx}->over->query_xover($beg, $end)})) {
 744                 $range_info->[0] = $msgs->[-1]->{num} + 1;
 745                 return;
 746         }
 747         return 'OK Fetch done' if !$range_csv;
 748         my $next_range = range_step($self, \$range_csv);
 749         return $next_range if !ref($next_range); # error
 750         @$range_info = @$next_range;
 751         undef; # keep looping
 752 }
 753
 754 sub fetch_blob { # long_response
 755         my ($self, $tag, $msgs, $range_info, $ops, $partial) = @_;
 756         while (!@$msgs) { # rare
 757                 if (my $end = refill_range($self, $msgs, $range_info)) {
 758                         $self->write(\"$tag $end\r\n");
 759                         return;
 760                 }
 761         }
 762         uo2m_extend($self, $msgs->[-1]->{num});
 763         git_async_cat($self->{ibx}->git, $msgs->[0]->{blob},
 764                         \&fetch_blob_cb, \@_);
 765 }
 766
 767 sub fetch_smsg { # long_response
 768         my ($self, $tag, $msgs, $range_info, $ops) = @_;
 769         while (!@$msgs) { # rare
 770                 if (my $end = refill_range($self, $msgs, $range_info)) {
 771                         $self->write(\"$tag $end\r\n");
 772                         return;
 773                 }
 774         }
 775         uo2m_extend($self, $msgs->[-1]->{num});
 776         fetch_run_ops($self, $_, undef, $ops) for @$msgs;
 777         @$msgs = ();
 778         1; # more
 779 }
 780
 781 sub refill_uids ($$$;$) {
 782         my ($self, $uids, $range_info, $sql) = @_;
 783         my ($beg, $end, $range_csv) = @$range_info;
 784         my $over = $self->{ibx}->over;
 785         while (1) {
 786                 if (scalar(@$uids = @{$over->uid_range($beg, $end, $sql)})) {
 787                         $range_info->[0] = $uids->[-1] + 1; # update $beg
 788                         return;
 789                 } elsif (!$range_csv) {
 790                         return 0;
 791                 } else {
 792                         my $next_range = range_step($self, \$range_csv);
 793                         return $next_range if !ref($next_range); # error
 794                         ($beg, $end, $range_csv) = @$range_info = @$next_range;
 795                         # continue looping
 796                 }
 797         }
 798 }
 799
 800 sub fetch_uid { # long_response
 801         my ($self, $tag, $uids, $range_info, $ops) = @_;
 802         if (defined(my $err = refill_uids($self, $uids, $range_info))) {
 803                 $err ||= 'OK Fetch done';
 804                 $self->write("$tag $err\r\n");
 805                 return;
 806         }
 807         my $adj = $self->{uid_base} + 1;
 808         my $uo2m = uo2m_extend($self, $uids->[-1]);
 809         $uo2m = [ unpack('S*', $uo2m) ] if !ref($uo2m);
 810         my ($i, $k);
 811         for (@$uids) {
 812                 $self->msg_more("* $uo2m->[$_ - $adj] FETCH (UID $_");
 813                 for ($i = 0; $i < @$ops;) {
 814                         $k = $ops->[$i++];
 815                         $ops->[$i++]->($self, $k);
 816                 }
 817                 $self->msg_more(")\r\n");
 818         }
 819         @$uids = ();
 820         1; # more
 821 }
 822
 823 sub cmd_status ($$$;@) {
 824         my ($self, $tag, $mailbox, @items) = @_;
 825         return "$tag BAD no items\r\n" if !scalar(@items);
 826         ($items[0] !~ s/\A\(//s || $items[-1] !~ s/\)\z//s) and
 827                 return "$tag BAD invalid args\r\n";
 828         my ($ibx, $exists, $uidnext) = inbox_lookup($self, $mailbox);
 829         return "$tag NO Mailbox doesn't exist: $mailbox\r\n" if !$ibx;
 830         my @it;
 831         for my $it (@items) {
 832                 $it = uc($it);
 833                 push @it, $it;
 834                 if ($it =~ /\A(?:MESSAGES|UNSEEN|RECENT)\z/) {
 835                         push @it, $exists;
 836                 } elsif ($it eq 'UIDNEXT') {
 837                         push @it, $uidnext;
 838                 } elsif ($it eq 'UIDVALIDITY') {
 839                         push @it, $ibx->{uidvalidity};
 840                 } else {
 841                         return "$tag BAD invalid item\r\n";
 842                 }
 843         }
 844         return "$tag BAD no items\r\n" if !@it;
 845         "* STATUS $mailbox (".join(' ', @it).")\r\n" .
 846         "$tag OK Status done\r\n";
 847 }
 848
 849 my %patmap = ('*' => '.*', '%' => '[^\.]*');
 850 sub cmd_list ($$$$) {
 851         my ($self, $tag, $refname, $wildcard) = @_;
 852         my $l = $self->{imapd}->{inboxlist};
 853         if ($refname eq '' && $wildcard eq '') {
 854                 # request for hierarchy delimiter
 855                 $l = [ qq[* LIST (\\Noselect) "." ""\r\n] ];
 856         } elsif ($refname ne '' || $wildcard ne '*') {
 857                 $wildcard =~ s!([^a-z0-9_])!$patmap{$1} // "\Q$1"!egi;
 858                 $l = [ grep(/ \Q$refname\E$wildcard\r\n\z/is, @$l) ];
 859         }
 860         \(join('', @$l, "$tag OK List done\r\n"));
 861 }
 862
 863 sub cmd_lsub ($$$$) {
 864         my (undef, $tag) = @_; # same args as cmd_list
 865         "$tag OK Lsub done\r\n";
 866 }
 867
 868 sub eml_index_offs_i { # PublicInbox::Eml::each_part callback
 869         my ($p, $all) = @_;
 870         my ($eml, undef, $idx) = @$p;
 871         if ($idx && lc($eml->ct->{type}) eq 'multipart') {
 872                 $eml->{imap_bdy} = $eml->{bdy} // \'';
 873         }
 874         $all->{$idx} = $eml; # $idx => Eml
 875 }
 876
 877 # prepares an index for BODY[$SECTION_IDX] fetches
 878 sub eml_body_idx ($$) {
 879         my ($eml, $section_idx) = @_;
 880         my $idx = $eml->{imap_all_parts} //= do {
 881                 my $all = {};
 882                 $eml->each_part(\&eml_index_offs_i, $all, 0, 1);
 883                 # top-level of multipart, BODY[0] not allowed (nz-number)
 884                 delete $all->{0};
 885                 $all;
 886         };
 887         $idx->{$section_idx};
 888 }
 889
 890 # BODY[($SECTION_IDX)?(.$SECTION_NAME)?]<$offset.$bytes>
 891 sub partial_body {
 892         my ($eml, $section_idx, $section_name) = @_;
 893         if (defined $section_idx) {
 894                 $eml = eml_body_idx($eml, $section_idx) or return;
 895         }
 896         if (defined $section_name) {
 897                 if ($section_name eq 'MIME') {
 898                         # RFC 3501 6.4.5 states:
 899                         #       The MIME part specifier MUST be prefixed
 900                         #       by one or more numeric part specifiers
 901                         return unless defined $section_idx;
 902                         return $eml->header_obj->as_string . "\r\n";
 903                 }
 904                 my $bdy = $eml->{bdy} // $eml->{imap_bdy} // \'';
 905                 $eml = PublicInbox::Eml->new($$bdy);
 906                 if ($section_name eq 'TEXT') {
 907                         return $eml->body_raw;
 908                 } elsif ($section_name eq 'HEADER') {
 909                         return $eml->header_obj->as_string . "\r\n";
 910                 } else {
 911                         die "BUG: bad section_name=$section_name";
 912                 }
 913         }
 914         ${$eml->{bdy} // $eml->{imap_bdy} // \''};
 915 }
 916
 917 # similar to what's in PublicInbox::Eml::re_memo, but doesn't memoize
 918 # to avoid OOM with malicious users
 919 sub hdrs_regexp ($) {
 920         my ($hdrs) = @_;
 921         my $names = join('|', map { "\Q$_" } split(/[ \t]+/, $hdrs));
 922         qr/^(?:$names):[ \t]*[^\n]*\r?\n # 1st line
 923                 # continuation lines:
 924                 (?:[^:\n]*?[ \t]+[^\n]*\r?\n)*
 925                 /ismx;
 926 }
 927
 928 # BODY[($SECTION_IDX.)?HEADER.FIELDS.NOT ($HDRS)]<$offset.$bytes>
 929 sub partial_hdr_not {
 930         my ($eml, $section_idx, $hdrs_re) = @_;
 931         if (defined $section_idx) {
 932                 $eml = eml_body_idx($eml, $section_idx) or return;
 933         }
 934         my $str = $eml->header_obj->as_string;
 935         $str =~ s/$hdrs_re//g;
 936         $str =~ s/(?<!\r)\n/\r\n/sg;
 937         $str .= "\r\n";
 938 }
 939
 940 # BODY[($SECTION_IDX.)?HEADER.FIELDS ($HDRS)]<$offset.$bytes>
 941 sub partial_hdr_get {
 942         my ($eml, $section_idx, $hdrs_re) = @_;
 943         if (defined $section_idx) {
 944                 $eml = eml_body_idx($eml, $section_idx) or return;
 945         }
 946         my $str = $eml->header_obj->as_string;
 947         $str = join('', ($str =~ m/($hdrs_re)/g));
 948         $str =~ s/(?<!\r)\n/\r\n/sg;
 949         $str .= "\r\n";
 950 }
 951
 952 sub partial_prepare ($$$$) {
 953         my ($need, $partial, $want, $att) = @_;
 954
 955         # recombine [ "BODY[1.HEADER.FIELDS", "(foo", "bar)]" ]
 956         # back to: "BODY[1.HEADER.FIELDS (foo bar)]"
 957         return unless $att =~ /\ABODY\[/s;
 958         until (rindex($att, ']') >= 0) {
 959                 my $next = shift @$want or return;
 960                 $att .= ' ' . uc($next);
 961         }
 962         if ($att =~ /\ABODY\[([0-9]+(?:\.[0-9]+)*)? # 1 - section_idx
 963                         (?:\.(HEADER|MIME|TEXT))? # 2 - section_name
 964                         \](?:<([0-9]+)(?:\.([0-9]+))?>)?\z/sx) { # 3, 4
 965                 $partial->{$att} = [ \&partial_body, $1, $2, $3, $4 ];
 966                 $$need |= CRLF_BREF|EML_HDR|EML_BDY;
 967         } elsif ($att =~ /\ABODY\[(?:([0-9]+(?:\.[0-9]+)*)\.)? # 1 - section_idx
 968                                 (?:HEADER\.FIELDS(\.NOT)?)\x20 # 2
 969                                 \(([A-Z0-9\-\x20]+)\) # 3 - hdrs
 970                         \](?:<([0-9]+)(?:\.([0-9]+))?>)?\z/sx) { # 4 5
 971                 my $tmp = $partial->{$att} = [ $2 ? \&partial_hdr_not
 972                                                 : \&partial_hdr_get,
 973                                                 $1, undef, $4, $5 ];
 974                 $tmp->[2] = hdrs_regexp($3);
 975
 976                 # don't emit CRLF_HDR instruction, here, partial_hdr_*
 977                 # will do CRLF conversion with only the extracted result
 978                 # and not waste time converting lines we don't care about.
 979                 $$need |= EML_HDR;
 980         } else {
 981                 undef;
 982         }
 983 }
 984
 985 sub partial_emit ($$$) {
 986         my ($self, $partial, $eml) = @_;
 987         for (@$partial) {
 988                 my ($k, $cb, @args) = @$_;
 989                 my ($offset, $len) = splice(@args, -2);
 990                 # $cb is partial_body|partial_hdr_get|partial_hdr_not
 991                 my $str = $cb->($eml, @args) // '';
 992                 if (defined $offset) {
 993                         if (defined $len) {
 994                                 $str = substr($str, $offset, $len);
 995                                 $k =~ s/\.$len>\z/>/ or warn
 996 "BUG: unable to remove `.$len>' from `$k'";
 997                         } else {
 998                                 $str = substr($str, $offset);
 999                                 $len = length($str);
1000                         }
1001                 } else {
1002                         $len = length($str);
1003                 }
1004                 $self->msg_more(" $k {$len}\r\n");
1005                 $self->msg_more($str);
1006         }
1007 }
1008
1009 sub fetch_compile ($) {
1010         my ($want) = @_;
1011         if ($want->[0] =~ s/\A\(//s) {
1012                 $want->[-1] =~ s/\)\z//s or return 'BAD no rparen';
1013         }
1014         my (%partial, %seen, @op);
1015         my $need = 0;
1016         while (defined(my $att = shift @$want)) {
1017                 $att = uc($att);
1018                 next if $att eq 'UID'; # always returned
1019                 $att =~ s/\ABODY\.PEEK\[/BODY\[/; # we're read-only
1020                 my $x = $FETCH_ATT{$att};
1021                 if ($x) {
1022                         while (my ($k, $fl_cb) = each %$x) {
1023                                 next if $seen{$k}++;
1024                                 $need |= $fl_cb->[0];
1025                                 push @op, [ @$fl_cb, $k ];
1026                         }
1027                 } elsif (!partial_prepare(\$need, \%partial, $want, $att)) {
1028                         return "BAD param: $att";
1029                 }
1030         }
1031         my @r;
1032
1033         # stabilize partial order for consistency and ease-of-debugging:
1034         if (scalar keys %partial) {
1035                 $need |= NEED_BLOB;
1036                 $r[2] = [ map { [ $_, @{$partial{$_}} ] } sort keys %partial ];
1037         }
1038
1039         push @op, $OP_EML_NEW if ($need & (EML_HDR|EML_BDY));
1040
1041         # do we need CRLF conversion?
1042         if ($need & CRLF_BREF) {
1043                 push @op, $OP_CRLF_BREF;
1044         } elsif (my $crlf = ($need & (CRLF_HDR|CRLF_BDY))) {
1045                 if ($crlf == (CRLF_HDR|CRLF_BDY)) {
1046                         push @op, $OP_CRLF_BREF;
1047                 } elsif ($need & CRLF_HDR) {
1048                         push @op, $OP_CRLF_HDR;
1049                 } else {
1050                         push @op, $OP_CRLF_BDY;
1051                 }
1052         }
1053
1054         $r[0] = $need & NEED_BLOB ? \&fetch_blob :
1055                 ($need & NEED_SMSG ? \&fetch_smsg : \&fetch_uid);
1056
1057         # r[1] = [ $key1, $cb1, $key2, $cb2, ... ]
1058         use sort 'stable'; # makes output more consistent
1059         $r[1] = [ map { ($_->[2], $_->[1]) } sort { $a->[0] <=> $b->[0] } @op ];
1060         @r;
1061 }
1062
1063 sub cmd_uid_fetch ($$$$;@) {
1064         my ($self, $tag, $range_csv, @want) = @_;
1065         my $ibx = $self->{ibx} or return "$tag BAD No mailbox selected\r\n";
1066         my ($cb, $ops, $partial) = fetch_compile(\@want);
1067         return "$tag $cb\r\n" unless $ops;
1068
1069         # cb is one of fetch_blob, fetch_smsg, fetch_uid
1070         $range_csv = 'bad' if $range_csv !~ $valid_range;
1071         my $range_info = range_step($self, \$range_csv);
1072         return "$tag $range_info\r\n" if !ref($range_info);
1073         uo2m_hibernate($self) if $cb == \&fetch_blob; # slow, save RAM
1074         long_response($self, $cb, $tag, [], $range_info, $ops, $partial);
1075 }
1076
1077 sub cmd_fetch ($$$$;@) {
1078         my ($self, $tag, $range_csv, @want) = @_;
1079         my $ibx = $self->{ibx} or return "$tag BAD No mailbox selected\r\n";
1080         my ($cb, $ops, $partial) = fetch_compile(\@want);
1081         return "$tag $cb\r\n" unless $ops;
1082
1083         # cb is one of fetch_blob, fetch_smsg, fetch_uid
1084         $range_csv = 'bad' if $range_csv !~ $valid_range;
1085         msn_to_uid_range(msn2uid($self), $range_csv);
1086         my $range_info = range_step($self, \$range_csv);
1087         return "$tag $range_info\r\n" if !ref($range_info);
1088         uo2m_hibernate($self) if $cb == \&fetch_blob; # slow, save RAM
1089         long_response($self, $cb, $tag, [], $range_info, $ops, $partial);
1090 }
1091
1092 sub msn_convert ($$) {
1093         my ($self, $uids) = @_;
1094         my $adj = $self->{uid_base} + 1;
1095         my $uo2m = uo2m_extend($self, $uids->[-1]);
1096         $uo2m = [ unpack('S*', $uo2m) ] if !ref($uo2m);
1097         $_ = $uo2m->[$_ - $adj] for @$uids;
1098 }
1099
1100 sub search_uid_range { # long_response
1101         my ($self, $tag, $sql, $range_info, $want_msn) = @_;
1102         my $uids = [];
1103         if (defined(my $err = refill_uids($self, $uids, $range_info, $sql))) {
1104                 $err ||= 'OK Search done';
1105                 $self->write("\r\n$tag $err\r\n");
1106                 return;
1107         }
1108         msn_convert($self, $uids) if $want_msn;
1109         $self->msg_more(join(' ', '', @$uids));
1110         1; # more
1111 }
1112
1113 sub parse_query ($$) {
1114         my ($self, $query) = @_;
1115         my $q = PublicInbox::IMAPsearchqp::parse($self, $query);
1116         if (ref($q)) {
1117                 my $max = $self->{ibx}->over->max;
1118                 my $beg = 1;
1119                 uid_clamp($self, \$beg, \$max);
1120                 $q->{range_info} = [ $beg, $max ];
1121         }
1122         $q;
1123 }
1124
1125 sub refill_xap ($$$$) {
1126         my ($self, $uids, $range_info, $q) = @_;
1127         my ($beg, $end) = @$range_info;
1128         my $srch = $self->{ibx}->search;
1129         my $opt = { mset => 2, limit => 1000 };
1130         my $mset = $srch->mset("$q uid:$beg..$end", $opt);
1131         @$uids = @{$srch->mset_to_artnums($mset)};
1132         if (@$uids) {
1133                 $range_info->[0] = $uids->[-1] + 1; # update $beg
1134                 return; # possibly more
1135         }
1136         0; # all done
1137 }
1138
1139 sub search_xap_range { # long_response
1140         my ($self, $tag, $q, $range_info, $want_msn) = @_;
1141         my $uids = [];
1142         if (defined(my $err = refill_xap($self, $uids, $range_info, $q))) {
1143                 $err ||= 'OK Search done';
1144                 $self->write("\r\n$tag $err\r\n");
1145                 return;
1146         }
1147         msn_convert($self, $uids) if $want_msn;
1148         $self->msg_more(join(' ', '', @$uids));
1149         1; # more
1150 }
1151
1152 sub search_common {
1153         my ($self, $tag, $query, $want_msn) = @_;
1154         my $ibx = $self->{ibx} or return "$tag BAD No mailbox selected\r\n";
1155         my $q = parse_query($self, $query);
1156         return "$tag $q\r\n" if !ref($q);
1157         my ($sql, $range_info) = delete @$q{qw(sql range_info)};
1158         if (!scalar(keys %$q)) { # overview.sqlite3
1159                 $self->msg_more('* SEARCH');
1160                 long_response($self, \&search_uid_range,
1161                                 $tag, $sql, $range_info, $want_msn);
1162         } elsif ($q = $q->{xap}) {
1163                 $self->{ibx}->search or
1164                         return "$tag BAD search not available for mailbox\r\n";
1165                 $self->msg_more('* SEARCH');
1166                 long_response($self, \&search_xap_range,
1167                                 $tag, $q, $range_info, $want_msn);
1168         } else {
1169                 "$tag BAD Error\r\n";
1170         }
1171 }
1172
1173 sub cmd_uid_search ($$$) {
1174         my ($self, $tag, $query) = @_;
1175         search_common($self, $tag, $query);
1176 }
1177
1178 sub cmd_search ($$$;) {
1179         my ($self, $tag, $query) = @_;
1180         search_common($self, $tag, $query, 1);
1181 }
1182
1183 sub args_ok ($$) { # duplicated from PublicInbox::NNTP
1184         my ($cb, $argc) = @_;
1185         my $tot = prototype $cb;
1186         my ($nreq, undef) = split(';', $tot);
1187         $nreq = ($nreq =~ tr/$//) - 1;
1188         $tot = ($tot =~ tr/$//) - 1;
1189         ($argc <= $tot && $argc >= $nreq);
1190 }
1191
1192 # returns 1 if we can continue, 0 if not due to buffered writes or disconnect
1193 sub process_line ($$) {
1194         my ($self, $l) = @_;
1195
1196         # TODO: IMAP allows literals for big requests to upload messages
1197         # (which we don't support) but maybe some big search queries use it.
1198         # RFC 3501 9 (2) doesn't permit TAB or multiple SP
1199         my ($tag, $req, @args) = parse_line('[ \t]+', 0, $l);
1200         pop(@args) if (@args && !defined($args[-1]));
1201         if (@args && uc($req) eq 'UID') {
1202                 $req .= "_".(shift @args);
1203         }
1204         my $res = eval {
1205                 if (defined(my $idle_tag = $self->{-idle_tag})) {
1206                         (uc($tag // '') eq 'DONE' && !defined($req)) ?
1207                                 idle_done($self, $tag) :
1208                                 "$idle_tag BAD expected DONE\r\n";
1209                 } elsif (my $cmd = $self->can('cmd_'.lc($req // ''))) {
1210                         if ($cmd == \&cmd_uid_search || $cmd == \&cmd_search) {
1211                                 # preserve user-supplied quotes for search
1212                                 (undef, @args) = split(/ search /i, $l, 2);
1213                         }
1214                         $cmd->($self, $tag, @args);
1215                 } else { # this is weird
1216                         auth_challenge_ok($self) //
1217                                         ($tag // '*') .
1218                                         ' BAD Error in IMAP command '.
1219                                         ($req // '(???)').
1220                                         ": Unknown command\r\n";
1221                 }
1222         };
1223         my $err = $@;
1224         if ($err && $self->{sock}) {
1225                 $l =~ s/\r?\n//s;
1226                 err($self, 'error from: %s (%s)', $l, $err);
1227                 $tag //= '*';
1228                 $res = "$tag BAD program fault - command not performed\r\n";
1229         }
1230         return 0 unless defined $res;
1231         $self->write($res);
1232 }
1233
1234 sub long_step {
1235         my ($self) = @_;
1236         # wbuf is unset or empty, here; {long} may add to it
1237         my ($fd, $cb, $t0, @args) = @{$self->{long_cb}};
1238         my $more = eval { $cb->($self, @args) };
1239         if ($@ || !$self->{sock}) { # something bad happened...
1240                 delete $self->{long_cb};
1241                 my $elapsed = now() - $t0;
1242                 if ($@) {
1243                         err($self,
1244                             "%s during long response[$fd] - %0.6f",
1245                             $@, $elapsed);
1246                 }
1247                 out($self, " deferred[$fd] aborted - %0.6f", $elapsed);
1248                 $self->close;
1249         } elsif ($more) { # $self->{wbuf}:
1250                 $self->update_idle_time;
1251
1252                 # control passed to git_async_cat if $more == \undef
1253                 requeue_once($self) if !ref($more);
1254         } else { # all done!
1255                 delete $self->{long_cb};
1256                 my $elapsed = now() - $t0;
1257                 my $fd = fileno($self->{sock});
1258                 out($self, " deferred[$fd] done - %0.6f", $elapsed);
1259                 my $wbuf = $self->{wbuf}; # do NOT autovivify
1260
1261                 $self->requeue unless $wbuf && @$wbuf;
1262         }
1263 }
1264
1265 sub err ($$;@) {
1266         my ($self, $fmt, @args) = @_;
1267         printf { $self->{imapd}->{err} } $fmt."\n", @args;
1268 }
1269
1270 sub out ($$;@) {
1271         my ($self, $fmt, @args) = @_;
1272         printf { $self->{imapd}->{out} } $fmt."\n", @args;
1273 }
1274
1275 sub long_response ($$;@) {
1276         my ($self, $cb, @args) = @_; # cb returns true if more, false if done
1277
1278         my $sock = $self->{sock} or return;
1279         # make sure we disable reading during a long response,
1280         # clients should not be sending us stuff and making us do more
1281         # work while we are stream a response to them
1282         $self->{long_cb} = [ fileno($sock), $cb, now(), @args ];
1283         long_step($self); # kick off!
1284         undef;
1285 }
1286
1287 # callback used by PublicInbox::DS for any (e)poll (in/out/hup/err)
1288 sub event_step {
1289         my ($self) = @_;
1290
1291         return unless $self->flush_write && $self->{sock} && !$self->{long_cb};
1292
1293         $self->update_idle_time;
1294         # only read more requests if we've drained the write buffer,
1295         # otherwise we can be buffering infinitely w/o backpressure
1296
1297         my $rbuf = $self->{rbuf} // \(my $x = '');
1298         my $line = index($$rbuf, "\n");
1299         while ($line < 0) {
1300                 if (length($$rbuf) >= LINE_MAX) {
1301                         $self->write(\"\* BAD request too long\r\n");
1302                         return $self->close;
1303                 }
1304                 $self->do_read($rbuf, LINE_MAX, length($$rbuf)) or
1305                                 return uo2m_hibernate($self);
1306                 $line = index($$rbuf, "\n");
1307         }
1308         $line = substr($$rbuf, 0, $line + 1, '');
1309         $line =~ s/\r?\n\z//s;
1310         return $self->close if $line =~ /[[:cntrl:]]/s;
1311         my $t0 = now();
1312         my $fd = fileno($self->{sock});
1313         my $r = eval { process_line($self, $line) };
1314         my $pending = $self->{wbuf} ? ' pending' : '';
1315         out($self, "[$fd] %s - %0.6f$pending - $r", $line, now() - $t0);
1316
1317         return $self->close if $r < 0;
1318         $self->rbuf_idle($rbuf);
1319         $self->update_idle_time;
1320
1321         # maybe there's more pipelined data, or we'll have
1322         # to register it for socket-readiness notifications
1323         $self->requeue unless $pending;
1324 }
1325
1326 sub compressed { undef }
1327
1328 sub zflush {} # overridden by IMAPdeflate
1329
1330 # RFC 4978
1331 sub cmd_compress ($$$) {
1332         my ($self, $tag, $alg) = @_;
1333         return "$tag BAD DEFLATE only\r\n" if uc($alg) ne "DEFLATE";
1334         return "$tag BAD COMPRESS active\r\n" if $self->compressed;
1335
1336         # CRIME made TLS compression obsolete
1337         # return "$tag NO [COMPRESSIONACTIVE]\r\n" if $self->tls_compressed;
1338
1339         PublicInbox::IMAPdeflate->enable($self, $tag);
1340         $self->requeue;
1341         undef
1342 }
1343
1344 sub cmd_starttls ($$) {
1345         my ($self, $tag) = @_;
1346         my $sock = $self->{sock} or return;
1347         if ($sock->can('stop_SSL') || $self->compressed) {
1348                 return "$tag BAD TLS or compression already enabled\r\n";
1349         }
1350         my $opt = $self->{imapd}->{accept_tls} or
1351                 return "$tag BAD can not initiate TLS negotiation\r\n";
1352         $self->write(\"$tag OK begin TLS negotiation now\r\n");
1353         $self->{sock} = IO::Socket::SSL->start_SSL($sock, %$opt);
1354         $self->requeue if PublicInbox::DS::accept_tls_step($self);
1355         undef;
1356 }
1357
1358 # for graceful shutdown in PublicInbox::Daemon:
1359 sub busy {
1360         my ($self, $now) = @_;
1361         if (defined($self->{-idle_tag})) {
1362                 $self->write(\"* BYE server shutting down\r\n");
1363                 return; # not busy anymore
1364         }
1365         ($self->{rbuf} || $self->{wbuf} || $self->not_idle_long($now));
1366 }
1367
1368 sub close {
1369         my ($self) = @_;
1370         if (my $ibx = delete $self->{ibx}) {
1371                 stop_idle($self, $ibx);
1372         }
1373         $self->SUPER::close; # PublicInbox::DS::close
1374 }
1375
1376 # we're read-only, so SELECT and EXAMINE do the same thing
1377 no warnings 'once';
1378 *cmd_select = \&cmd_examine;
1379
1380 package PublicInbox::IMAP_preauth;
1381 our @ISA = qw(PublicInbox::IMAP);
1382
1383 sub logged_in { 0 }
1384
1385 1;