about summary refs log tree commit homepage
path: root/lib/PublicInbox/IMAP.pm
DateCommit message (Collapse)
2020-06-16imap: fix UID-offset-to-MSN mapping bugs
We need to clear the UID-offset-to-MSN mapping when leaving mailboxes via EXAMINE/SELECT/CLOSE. Furthermore, uo2m_last_uid() needs to account for tiny mailboxes where the scalar representation of {uo2m} may be evaluated to `false' in a boolean context.
2020-06-16imap: *SEARCH: fix CHARSET handling
We no longer pass an arrayref to search_common() or parse_query(), so handle the CHARSET directive in the Parse::RecDescent-generated parser directly.
2020-06-16imap: *SEARCH: use Parse::RecDescent
For properly parsing IMAP search requests, it's easier to use a recursive descent parser generator to deal with subqueries and the "OR" statement. Parse::RecDescent was chosen since it's mature, well-known, widely available and already used by our optional dependencies: Inline::C and Mail::IMAPClient. While it's possible to build Xapian queries without using the Xapian string query parser; this iteration of the IMAP parser still builds a string which is passed to Xapian's query parser for ease-of-diagnostics. Since this is a recursive descent parser dealing with untrusted inputs, subqueries have a nesting limit of 10. I expect that is more than adequate for real-world use.
2020-06-16imap: reinstate non-UID SEARCH
Since we support MSNs properly, now, it seems acceptable to support regular SEARCH requests in case there are any clients which still use non-UID SEARCH.
2020-06-16imap: stop_idle: fix parameter parsing :x
stop_idle was a noop when the client issues a "DONE" continuation or just disconnects. This would not have led to a long term memory leak since FDs get closed and reused, anyways, and all of our InboxIdle mappings are keyed by FD.
2020-06-16imap: improve IDLE handling at graceful shutdown
Since IMAP IDLE users aren't expected to issue any commands, we can terminate their connections immediately on graceful shutdown. Furthermore, we need to drop the inotify FD from the epoll set to avoid warnings during global destruction. Embarassingly, this required fixing wacky test ordering from 2a717d13f10fcdc6 ("nntpd+imapd: detect replaced over.sqlite3")
2020-06-16imap: clarify "DONE" usage with IDLE
"DONE" is a continuation and not a normal IMAP command, so ensure it can't be called like a normal IMAP command which has a tag.
2020-06-13imap: introduce memory-efficient uo2m mapping
Since we limit our mailboxes slices to 50K and can guarantee a contiguous UID space for those mailboxes, we can store a mapping of "UID offsets" (not full UIDs) to Message Sequence Numbers as an array of 16-bit unsigned integers in a 100K scalar. For UID-only FETCH responses, we can momentarily unpack the compact 100K representation to a ~1.6M Perl array of IV/UV elements for a slight speedup. Furthermore, we can (ab)use hash key deduplication in Perl5 to deduplicate this 100K scalar across all clients with the same mailbox slice open. Technically we can increase our slice size to 64K w/o increasing our storage overhead, but I suspect humans are more accustomed to slices easily divisible by 10.
2020-06-13imap: FETCH: proper MSN => UID mapping for requests
This finally seems to make mutt header caching behave properly. We expect to be able to safely load 50K IV/UVs in memory without OOM, since that's "only" 1.6 MB that won't live beyond a single event loop iteration. So create a simple array which can quickly map MSNs in requests to UIDs and not leave out messages. MSNs in the FETCH response will NOT be correct, since it's inefficient to implement properly and mutt doesn't seem to care. Since the conversion code is easily shared, "UID SEARCH" can allow the same MSN => UID mapping non-UID "FETCH" does.
2020-06-13imap: remove non-UID SEARCH for now
Supporting MSNs in long-lived connections beyond the lifetime of a single request/response cycle is not scalable to a C10K scenario. It's probably not needed, since most clients seem to use UIDs. A somewhat efficient implementation I can come up uses pack("S*" ...) (AKA "uint16_t mapping[50000]") has an overhead of 100K per-client socket on a mailbox with 50K messages. The 100K is a contiguous scalar, so it could be swapped out for idle clients on most architectures if THP is disabled. An alternative could be to use a tempfile as an allocator partitioned into 100K chunks (or SQLite); but I'll only do that if somebody presents a compelling case to support MSN SEARCH.
2020-06-13imap: misc cleanups and notes
Note some of our limitations for potential hackers. We'll be renaming "UID_BLOCK" to "UID_SLICE", since "block" is overused term and "slice" isn't used in our codebase. Also, document how "slice" and "epochs" are similar concepts for different clients.
2020-06-13imap: wire up Xapian, MSN SEARCH and multi sequence-sets
Simple queries work, more complex queries involving parentheses, "OR", "NOT" don't work, yet. Tested with "=b", "=B", and "=H" search and limits in mutt on both v1 and v2 with multiple Xapian shards.
2020-06-13imap: UID SEARCH: support multiple ranges
We can share a bit of code with FETCH to refill UID ranges which hit the SQLite overview.
2020-06-13imap: STATUS/EXAMINE: rely on SQLite overview
We can get exact values for EXISTS, UIDNEXT using SQLite rather than calculating off $ibx->mm->max ourselves. Furthermore, $ibx->mm is less useful than $ibx->over for IMAP (and for our read-only daemons in general) so do not depend on $ibx->mm outside of startup/reload to save FDs and reduce kernel page cache footprint.
2020-06-13imap: FETCH: try to make fake MSNs sequentially
This appears to significantly improve header caching behavior with mutt. With the current public-inbox.org/git mirror(*), mutt will only re-FETCH the last ~300 or so messages in the final "inbox.comp.version-control.git.7" mailbox, instead of ~49,000 messages every time. It's not perfect, but a 500ms query is better than a >10s query and mutt itself spends as much time loading its header cache. (*) there are many gaps in NNTP article numbers (UIDs) due to spam removal from public-inbox-learn.
2020-06-13imap: further speed up HEADER.FIELDS FETCH requests
Since headers are big and include a lot of lines MUAs don't care about, we can skip the CRLF_HDR ops and just do the CRLF conversion in partial_hdr_get and partial_hdr_not. This is another 10-15% speedup for mutt w/o header caching.
2020-06-13imap: FETCH: more granular CRLF conversion
This speeds up requests from mutt for HEADER.FIELDS by around 10% since we don't waste time doing CRLF conversion on large message bodies that get discarded, anyways.
2020-06-13imap: cleanup ->{uid_base} usage
Ensure {uid_base} is always set, so we don't need to add `//' checks everywhere. Furthermore, this fixes a hard-to-test bug where the STATUS command would inadvertantly clobber {uid_base}.
2020-06-13imap: reinstate some message sequence number support
The performance problem with mutt not using header caches isn't fixed, yet, but mutt header caching seems to depend on MSNs (message sequence numbers). We'll switch to storing the 0-based {uid_base} instead of the 1-based {uid_min} since it simplifies most of our code.
2020-06-13imap: support 8000 octet lines
RFC 2683 section 3.2.1.5 recommends it: > For its part, a server should allow for a command line of at least > 8000 octets. This provides plenty of leeway for accepting reasonable > length commands from clients. The server should send a BAD response > to a command that does not end within the server's maximum accepted > command length. To conserve memory, we won't bother reading the entire line before sending the BAD response and disconnecting them.
2020-06-13imap: LIST shows "INBOX" in all caps
While selecting a mailbox is done case-insensitively, "INBOX" is special for the LIST command, according to RFC 3501 6.3.8: > The special name INBOX is included in the output from LIST, if > INBOX is supported by this server for this user and if the > uppercase string "INBOX" matches the interpreted reference and > mailbox name arguments with wildcards as described above. The > criteria for omitting INBOX is whether SELECT INBOX will > return failure; it is not relevant whether the user's real > INBOX resides on this or some other server. Thus, the existing news.public-inbox.org convention of naming newsgroups starting with "inbox." needs to be special-cased to not confuse clients. While we're at it, do not create ".0" for dummy newsgroups if they're selected, either.
2020-06-13imap: UID FETCH requires at least one data item
It seems required based on my reading of RFC 3501 for the non-UID "FETCH" command.
2020-06-13imap: rely on smsg->{bytes} for RFC822.SIZE
Since we started indexing the CRLF-adjusted size of messages, we can take an order-of-magnitude speedup for certain MUAs which fetch this attribute without needing much else. Admins are encouraged to --reindex existing inboxes for IMAP support, anyways. It won't be fatal if it's not reindexed, but some client bugs and warnings can be fixed and they'll be able to support more of IMAP.
2020-06-13imap: split ->logged_in attribute into a separate class
This is one boolean attribute not worth wasting space for. With 20000 sockets, this reduces RSS by around 5% at a glance, and locked hashes doesn't do us much good when clients use compression, anyways.
2020-06-13imap: 30 minute auto-logout timer
RFC 3501 section 5.4 requires this to be >= 30 minutes, 10x higher than what is recommended for NNTP. Fortunately our design is reasonably memory-efficient despite being Perl.
2020-06-13imap: IDLE: avoid extraneous wakeups, keep-alive
We should not waste memory for IDLE unless it's used on the most recent inbox slice. We also need to keep the IDLE connection alive regardless of $PublicInbox::DS::EXPTIME.
2020-06-13imap: UID FETCH: optimize (UID FLAGS) harder
We can speed up this common mutt request by another 2-3x by not loading the entire smsg from SQLite, just the UID.
2020-06-13imap: UID FETCH: optimize for smsg-only case
We can avoid loading the entire message from git when mutt makes a "UID FETCH" request for "(UID FLAGS)". This speeds mutt up by more than an order-of-magnitude in informal measurements.
2020-06-13imap: compile UID FETCH to opcodes
This is just a hair faster and cacheable in the future, if we need it. Most notably, this avoids doing PublicInbox::Eml->new for simple "RFC822", "BODY[]", and "RFC822.SIZE" requests.
2020-06-13imap: remove dummies from sequence number FETCH
Dummy messages make for bad user experience with MUAs which still use sequence numbers. Not being able to fetch a message doesn't seem fatal in mutt, so just ignore (sometimes large) gaps.
2020-06-13imap: allow UID range search on timestamps
Since it seems somewhat common for IMAP clients to limit searches by sent Date: or INTERNALDATE, we can rely on the NNTP/WWW-optimized overview DB. For other queries, we'll have to depend on the Xapian DB.
2020-06-13imap: SEARCH: clamp results to the 50K UID range
We won't support searching across mailboxes, just yet; but maybe in the future.
2020-06-13imap: start parsing out queries for SQLite and Xapian
None of the new cases are wired up, yet, but existing cases still work.
2020-06-13imap: avoid uninitialized warnings on incomplete commands
No point in spewing "uninitialized" warnings into logs when the cat jumps on the Enter key.
2020-06-13imap: EXAMINE/STATUS: return correct counts
We can share code between them and account for each 50K mailbox slice. However, we must overreport these for non-zero slices and just return lots of empty data for high-numbered slices because some MUAs still insist on non-UID fetches.
2020-06-13imap: STATUS and LIST are case-insensitive, too
Some clients insist on sending "INBOX" in all caps, since it's special in RFC 3501.
2020-06-13imap: omit $UID_END from mailbox name, use index
Having two large numbers separated by a dash can make visual comparisons difficult when numbers are in the 3,000,000 range for LKML. So avoid the $UID_END value, since it can be calculated from $UID_MIN. And we can avoid large values of $UID_MIN, too, by instead storing the block index and just multiplying it by 50000 (and adding 1) on the server side. Of course, LKML still goes up to 72, at the moment.
2020-06-13imap: require ".$UID_MIN-$UID_END" suffix
Finish up the IMAP-only portion of iterative config reloading, which allows us to create all sub-ranges of an inbox up front. The InboxIdler still uses ->each_inbox which will struggle with 100K inboxes. Having messages in the top-level newsgroup name of an inbox will still waste bandwidth for clients which want to do full syncs once there's a rollover to a new 50K range. So instead, make every inbox accessible exclusively via 50K slices in the form of "$NEWSGROUP.$UID_MIN-$UID_END". This introduces the DummyInbox, which makes $NEWSGROUP and every parent component a selectable, empty inbox. This aids navigation with mutt and possibly other MUAs. Finally, the xt/perf-imap-list maintainer test is broken, now, so remove it. The grep perlfunc is already proven effective, and we'll have separate tests for mocking out ~100k inboxes.
2020-06-13imap: break giant inboxes into sub-inboxes of 50K messages
This limit on mailbox size should keep users of tools like mbsync (isync) and offlineimap happy, since typical filesystems struggle with giant Maildirs. I chose 50K since it's a bit more than what LKML typically sees in a month and still manages to give acceptable performance on my ancient Centrino laptop. There were also no responses to my original proposal at: <https://public-inbox.org/meta/20200519090000.GA24273@dcvr/> so no objections, either :>
2020-06-13imap: support out-of-bounds ranges
"$UID_START:*" needs to return at least one message according to RFC 3501 section 6.4.8. While we're in the area, coerce ranges to (unsigned) integers by adding zero ("+ 0") to reduce memory overhead.
2020-06-13git: move async_cat reference to PublicInbox::Git
Trying to avoid a circular reference by relying on $ibx object here makes no sense, since skipping GitCatAsync::close will result in an FD leak, anyways. So keep GitAsyncCat contained to git-only operations, since we'll be using it for Solver in the distant feature.
2020-06-13imap: fix pipelining with async git
Since IMAP yields control to GitAsyncCat, IMAP->event_step may be invoked with {long_cb} still active. We must be sure to bail out of IMAP->event_step if that happens and continue to let GitAsyncCat drive IMAP. This also improves fairness by never processing more than one request per ->event_step.
2020-06-13imap: FETCH: support comma-delimited ranges
The RFC 3501 `sequence-set' definition allows comma-delimited ranges, so we'll support it in case clients send them. Coalescing overlapping ranges isn't required, so we won't support it as such an attempt to save bandwidth would waste memory on the server, instead.
2020-06-13imap: support LSUB command
Since we only support read-only operation, we can't save subscriptions requested by clients. So just list no inboxes as subscribed, some MUAs may blindly try to fetch everything its subscribed to.
2020-06-13imap: use git-cat-file asynchronously
This ought to improve overall performance with multiple clients. Single client performance suffers a tiny bit due to extra syscall overhead from epoll. This also makes the existing async interface easier-to-use, since calling cat_async_begin is no longer required.
2020-06-13imap: speed up HEADER.FIELDS[.NOT] range fetches
While we can't memoize the regexp forever like we do with other Eml users, we can still benefit from caching regexp compilation on a per-request basis. A FETCH request from mutt on a 4K message inbox is around 8% faster after this. Since regexp compilation via qr// isn't unbearably slow, a shared cache probably isn't worth the trouble of implementing. A per-request cache seems enough.
2020-06-13imap: support the CLOSE command
It seems worthless to support CLOSE for read-only inboxes, but mutt sends it, so don't return a BAD error with proper use.
2020-06-13imap: do not include ".PEEK" in responses
They're not specified in RFC 3501 for responses, and at least mutt fails to handle it.
2020-06-13imap: support sequence number FETCH
We'll return dummy messages for now when sequence numbers go missing, in case clients can't handle missing messages.
2020-06-13imap: simplify partial fetch structure
While the contents of normal %want hash keys are bounded in size, %partial can cause more overhead and lead to repeated sort calls on multi-message fetches. So sort it once and use arrayrefs to make the data structure more compact.