searchidx: increase term positions for all text terms

We do not want phrase searches to cross between independent
fields (filenames/Message-ID vs bodies)

use %H consistently to disable abbreviations

We generally do not want git to waste time finding abbreviations
and we do not want the possibility of them becoming ambiguous
over time, either.

extmsg: remove expensive git path checks

Searching across different inboxes is expensive without
SQLite (or Xapian) installed, so avoid doing expensive tree
lookups in git.  Since SQLite is required for Xapian
support anyways, we won't need to check Xapian, either.

Sites without SQLite installed will simply 404 if somebody
requests a message which isn't in the current inbox.

searchidx: regenerate and avoid article number gaps on full index

Some messages to git@vger went missing from Msgmap from old bugs
and became inaccessible via NNTP.  Forcing NNTP article numbers
when the overview DB came about made the problem more visible when
reindexing old (v1) repositories as all removed spam messages
took up AUTOINCREMENT numbers again before they were removed.

Having large gaps in NNTP article numbers is not good since it
throws off NNTP clients.  This does NOT prevent NNTP clients from
seeing some messages twice, but is better than having them
miss several messages entirely.

We also avoid depending on --reverse in git-log, as
git requires storing an entire commit list in memory for
--reverse, so it's cheaper to store only deleted blobs in the %D
hash since they do not live long.

import: cat_blob drops leading 'From ' lines like Inbox

In case people were running old buggy versions from 2016...
(and -convert should probably clean those up, eventually)

v2: improve deduplication checks

First off, decode text portions of messages since some archived
mail I got was converted from quoted-printable or base-64 to
8bit by the original recipient.  Attempting to merge them with
my own archives (which had no conversion done) led to
unnecessary duplicates showing up.

Then, normalize CRLF line endings in text portions to LF.

In the headers, we relax the content_id hashing to ignore quotes
and lower-case domain names in To, Cc, and From headers since
some mail processors will alter them.

Finally, I've discovered Email::MIME->new($mime->as_string)
does not always round-trip reliably, so we calculate the
content_id twice on user-supplied messages.

v2: generate better Message-IDs for duplicates

While hunting duplicates, I noticed a leading '-' in some
Message-IDs as a result of RFC4648 encoding.  While '-' seems
allowed by RFC5322 and URL-friendly (RFC4648), they are uncommon
and make using Message-IDs as arguments for command-line tools
more difficult.  So prefix them with a datestamp to at least
give readers some sense of the age.  And shorten the "localhost"
hostname to "z" to save space.

search: preserve References in Xapian smsg for x=t view

I'm not sure how useful this view is, but it exists for now.

v2writable: reduce partititions by one

git fast-import and the main V2Writable process combined takes
about one CPU, so avoid having too many Xapian partitions which
cause unnecessary I/O contention.

compact: do not merge v2 repos by default

--no-renumber does not allow merging, and merging is not ideal
for reindexing, either.

v1: remove articles from overview DB

Otherwise articles show up again...

feed: respect feedmax, again

Gigantic feeds probably make some clients unhappy,
clamp it to what it was in the past.

Fixes: b9534449ecce2c59 ("view: avoid offset during pagination")

msgmap: speed up minmax with separate queries

This significantly improves the performance of the NNTP GROUP
command with 2.7 million messages from over 250ms to 700us.
SQLite is weird about this, but at least there's a way to
optimize it.

store less data in the Xapian document

Since we only query the SQLite over DB for OVER/XOVER; do not
need to waste space storing fields To/Cc/:bytes/:lines or the
XNUM term.  We only use From/Subject/References/Message-ID/:blob
in various places of the PSGI code.

For reindexing, we will take advantage of docid stability
in "xapian-compact --no-renumber" to ensure duplicates do not
show up in search results.  Since the PSGI interface is the
only consumer of Xapian at the moment, it has no need to
search based on NNTP article number.

convert: support converting with altid defined

public-inbox-convert ought to be 100% lossless, now

index: allow specifying --jobs=0 to disable multiprocess

Not everybody needs multiprocess support.

v2writable: reduce barriers

Since we handle the overview info synchronously, we only need
barriers in tests, now.  We will use asynchronous checkpoints
to sync less-important Xapian data.

For data deduplication, this requires us to hoist out the
cat-blob support in ::Import for reading uncommitted data
in git.

over: remove forked subprocess

Since the overview stuff is a synchronization point anyways,
move it into the main V2Writable process and allow us to
drop a bunch of code.  This is another step towards making
Xapian optional for v2.

In other words, the fan-out point is moved and the Xapian
partitions no longer need to synchronize against each other:

Before:
                     /-------->\
                    /---------->\
     v2writable -->+----parts----> over
                    \---------->/
                     \-------->/

After:

                          /---------->
                         /----------->
  v2writable --> over-->+----parts--->
                         \----------->
                          \---------->

Since the overview/threading logic needs to run on the same core
that feeds git-fast-import, it's slower for small repos but is
not noticeable in large imports where I/O wait in the partitions
dominates.

over: avoid excessive SELECT

No need to read what we don't need into the Perl process.
Fix some broken capitalization while we're at it.

psgi: ensure /$INBOX/$MESSAGE_ID/T/ endpoint is chronological

We only need to call get_thread beyond 1000 messages for
fetching entire mboxes.  It's probably too much for the HTML
display otherwise.

ensure Xapian and SQLite are still optional for v1 tests

Xapian is size-intensive and SQLite is not strictly necessary for v1.

www: favor reading more from SQLite, and less from Xapian

Favor simpler internal APIs this time around, this cuts
a fair amount of code out and takes another step towards
removing Xapian as a dependency for v2 repos.

nntp: set Xref across multiple inboxes

Noted by Jonathan Corbet in https://lwn.net/Articles/748184/

altid: fix miscopied field name

Oops :x

search: index and allow searching by date-time

Dscho found this useful for finding matching git commits based
on AuthorDate in git.  Add it to the overview DB format, too;
 so in the future we can support v2 repos without Xapian.

https://public-inbox.org/git/nycvar.QRO.7.76.6.1804041821420.55@ZVAVAG-6OXH6DA.rhebcr.pbec.zvpebfbsg.pbz
https://public-inbox.org/git/alpine.DEB.2.20.1702041206130.3496@virtualbox/

over: use only supported and safe SQLite APIs

Some of this jankiness was from early performance problems
and they turned out to be unnecessary measures.

v2writable: refer to git each repository as "epoch"

This hopefully helps for people who try to understand
this design.

v2writable: allow tracking parallel versions

For upgrades, this will let users keep an old version
running while performing "public-inbox-index" on the
newest version.

v2writable: remove redundant remove from Over DB

The Xapian partitions will trigger the removal anyways.
Test this and fix some description/spelling errors
while we're at it.

compact: better handling of over.sqlite3* files

Lets not scare users when they encounter files that are supposed
to be there.  Then, preserve the journal and pipe.lock, even if
they're supposedly unused due to us holding the inbox-wide lock.

support altid mechanism for v2

There's enough gmane links out there in wild that it makes sense
to maintain support for these mappings.

searchview: minor cleanup

$mset->size is probably more obvious than relying on a tied
array and saves us a line.

mbox: do not sort search results

Sorting large msets is a waste when it comes to mboxes
since MUAs should thread and sort them as the user desires.

This forces us to rework each of the mbox download mechanisms
to be more independent of each other, but might make things
easier to reason about.

search: remove unnecessary OP_AND of query

This was vestigial code from the switch to the overview DB

searchmsg: remove unused `tid' and `path' methods

These internal attributes are not exposed and no longer
used in our APIs.

v2writable: recount partitions after acquiring lock

The partition count can change if public-inbox-compact runs
while public-inbox-watch or public-inbox-index is running.

v2writable: do not modify DBs while iterating for ->remove

Xapian may become unhappy if a DB is modified during iteration:
nntp://news.gmane.org/20180228004400.GU12724@survex.com

v2: support incremental indexing + purge

This is important for people running mirrors via "git fetch",
as they need to be kept up-to-date.  Purging is also now
supported in mirrors.

The short-lived "--regenerate" option is gone and is now
implicitly enabled as a result.  It's still cheap when
article number regeneration is unnecessary, as we track
the range for each git repository.

import: rewrite less history during purge

We do not need to rewrite old commits unaffected by the object_id
purge, only newer commits.  This was a state management bug :x

We will also return the new commit ID of rewritten history to
aid in incremental indexing of mirrors for the next change.

init: s/GIT_DIR/REPO_DIR/ in usage

searchidx: ensure duplicated Message-IDs can be linked together

This allows us to emulate the display of thread-aware MUAs when
multiple messages share the same Message-ID.  This also is a
place where "public-inbox-index --reindex" is useful to fix
existing messages and no schema version bump is necessary.

nntp: simplify the long_response API

We we worked around the default range/termination conditions of
long_response in many cases to reduce calls to SQLite or Xapian.
So continue that trend and become more like the PSGI API
which doesn't force callers to specify an article range or
work inside a loop.

msgmap: replace id_batch with ids_after

id_batch had a an overly complicated interface, replace it
with id_batch which is simpler and takes advantage of
selectcol_arrayref in DBI.  This allows simplification of
callers and the diffstat agrees with me.

mbox: remove remaining OFFSET usage in SQLite

We can use id_batch in the common case to speed up full mbox
retrievals.  Gigantic msets are still a problem, but will
be fixed in future commits.

view: avoid offset during pagination

OFFSET in SQLite gets painful to deal with.  Instead,
rely on timestamps (from Received:) for pagination.
This also sets us up for more precise Date searching
in case we want it.

nntp: make XOVER, XHDR, OVER, HDR and NEWNEWS faster

While SQLite is faster than Xapian for some queries we
use, it sucks at handling OFFSET.  Fortunately, we do
not need offsets when retrieving sorted results and
can bake it into the query.

For inbox.comp.version-control.git (v1 Xapian),
XOVER and XHDR are over 20x faster.

rename+rewrite test using Benchmark module

There'll be more performance-related tests in the future.

t/thread-all.t: modernize test to support modern inboxes

We'll be adding more tests in the same vein as this
to improve NNTP performance.

over: speedup get_thread by avoiding JOIN

JOIN operations on SQLite can be disasterously slow.
This reduces per-message pages with the thread overview
at the bottom of those pages from over 800ms to ~60ms.
In comparison, the v1 code took around 70-80ms using
Xapian on my machine.

www: rework query responses to avoid COUNT in SQLite

In many cases, we do not care about the total number of
messages.  It's a rather expensive operation in SQLite
(Xapian only provides an estimate).

For LKML, this brings top-level /$INBOX/ loading time from
~375ms to around 60ms on my system.  Days ago, this operation
was taking 800-900ms(!) for me before introducing the SQLite
overview DB.

t/over: test empty Subject: line matching

We need to ensure we don't match NULL 'sid' columns in the
`over' table.

v2writable: simplify barrier vs checkpoints

searchidx_checkpoint was too convoluted and confusing.
Since barrier is mostly the same thing; use that instead
and add an fsync option for the overview DB.

replace Xapian skeleton with SQLite overview DB

This ought to provide better performance and scalability
which is less dependent on inbox size.  Xapian does not
seem optimized for some queries used by the WWW homepage,
Atom feeds, XOVER and NEWNEWS NNTP commands.

This can actually make Xapian optional for NNTP usage,
and allow more functionality to work without Xapian
installed.

Indexing performance was extremely bad at first, but
DBI::Profile helped me optimize away problematic queries.

search: reduce columns stored in Xapian

We can store :bytes and :lines in doc_data since we never
sort or search by them.  We don't have much use for the Date:
stamp at the moment, either.

scripts/import_vger_from_mbox: set address properly

For objects like Inbox; the '-' prefixed hash keys are
probably intended for auto-generated/hidden parameters.

truncate Message-IDs and References consistently

We need to stop ghost messages from generating longer
Message-IDs than Xapian can handle with terms.

v2writable: fix parallel termination

I was too aggressively disabling parallelization to speed up
the test suite and broke this :x  Re-enable parallelization
for the v2reindex test so we can catch it later.

v2: one file, really

We need to ensure there is only one file in the top-level tree
at any commit so the "add; remove; add;" sequence on the same
message is detected properly.

Otherwise, git will not detect the second "add" unless
a second message is added to history.

Deletes are now stored in "d" (and not "D" or "_/D") at the
top-level, now.  There's no need to have a "_" to reduce churn
as "m" and "d" should never co-exist.  It's now lowercased to
make it easier-to-distinguish from "D" in git-log output.

searchidx: correct warning for over-vivification

We will vivify multiple ghosts if a message has multiple
Message-IDs.

v2: respect core.sharedRepository in git configs

Ensure -convert and -compact do not make repositories
unreadable on live servers.

t/v2writable: use simplify permissions reading

We have Git::qx nowadays.

search: move permissions handling to InboxWritable

We'll be making sure V2Writable uses this.

convert: avoid redundant "done\n" statement for fast-import

This bug was hidden due to timing problems with eatmydata or
running with tmpfs for TMPDIR.

msgtime: parse 3-digit years properly

Some folks had bad mail clients which generated 3-digit years
around Y2K...

feed: optimize query for feeds, too

This is a smaller improvement than the landing /$INBOX/ page
because full message bodies are shown; but still saves around
100ms for my system with LKML.

view: drop load_results

It's no longer necessary to have this since load_expand
now populates $smsg->mid with the "preferred" Message-ID.
This saves around 10ms on the homepage for me.

view: speed up homepage loading time with date clamp

This saves over 400ms on my system with the full LKML
with over 2.8 million messages.

v2writable: go backwards through alternate Message-IDs

This is consistent with how we internally generate new
Message-IDs to break conflicts and allows ->reindex to
succeed while walking backwards through history

wwwstream: flesh out clone instructions for v2

Relying solely on git for v2 repos is probably not
so useful, so add pointers to public-inbox-init/index
commands.

v2writable: convert some fatal reindex errors to warnings

By supporting purge and allowing users to delete git partitions,
we can open up ourselves to gaps and un-reindexible data.  Let
that be.

v2writable: allow gaps in git partitions

Somebody may only care about the most recent history,
so allow -init and -index to operate quietly on missing
partitions.

search: warn on reopens and die on total failure

-watch on a busy/giant Maildir caused too many Xapian
errors while attempting to browse.

mda: support v2 inboxes

I mainly focus on -watch for mirroring busy mailing lists, but
using -mda should remain an option.

public-inbox-compact: new tool for driving xapian-compact

Having multiple Xapian partitions is mostly pointless after
the initial import.  We can compact all the partitions into
one while keeping the skeleton separate.

v2writable: initializing an existing inbox is idempotent

And we do not want to start making confused repos if somebody
leaves out "-V2" the second time around.

import: run_die supports redirects as spawn does

We'll be using it in more future tests and scripts.

search: retry_reopen on first_smsg_by_mid

This was causing errors while attempting to load messages via
the WWW interface while mass-importing LKML.  While we're at it,
remove unnecessary eval from lookup_article.

view: get rid of some unnecessary imports

We no longer need some of these old subroutines which
assumed a single Message-ID for each message.

www: cleanup expensive fallback for legacy URLs

Back in the day, we compressed long Message-IDs to SHA-1
hexdigests for the URL.  This now redirects to a 301 in
the hopes we can remove these checks some day to reduce
overhead.

mbox: avoid extracting Message-ID for linkification

We can avoid a small amount of overhead and use the "preferred"
Message-ID based on what is in the SearchMsg object.

v2writable: cleanup: get rid of unused fields

The layout of this structure ended up being a bit different
and the read-only access is handled through the ::Inbox class,
instead.

search: move find_doc_ids to searchidx

We do not need this subroutine for read-only use in Search.pm

search: get rid of most lookup_* subroutines

Too many similar functions doing the same basic thing was
redundant and misleading, especially since Message-ID is
no longer treated as a truly unique identifier.

For displaying threads in the HTML, this makes it clear
that we favor the primary Message-ID mapped to an NNTP
article number if a message cannot be found.

search: cleanup uniqueness checking

The only Xapian term which should be unique is the NNTP article
number; so we no longer need find_unique_doc_id.

v2writable: support purging messages from git entirely

Purging existing messages is fairly straightforward since we can
take advantage of Xapian and lookup the git object_id with it.

Unfortunately, purging an already "removed" message (which is
no longer in Xapian) is not as easy and we'll need to expose
->purge_oids to purge by the git object_id (currently SHA-1).

Furthermore, we expire reflogs and prune in hopes a dumb HTTP
client won't get the object.

public-inbox-convert: tool for converting old to new inboxes

This should make it easier to let users perform comparisons and
migrate to v2 if needed.

searchmsg: document why we store To: and Cc: for NNTP

Otherwise I would forget and be tempted to remove them.

www: fix attachment downloads for conflicted Message-IDs

By using the "primary" Message-ID in WwwAttach, we can avoid
conflicts in the links we use for downloading attachments.

lookup by Message-ID favors the "primary" one

The Message-ID mapped to an NNTP article number is stronger,
so we will favor that for attachment lookups.

v2writable: append, instead of prepending generated Message-ID

The original Message-ID is still the most important when
discussing with other recipients who do not rely on a message
flowing through public-inbox.  So whatever Message-ID we use
to deduplicate internally will be secondary and less important.

All of our front-end v2 code is order-independent, so we won't
let the message count against us, that way.

www: remove unnecessary ghost checks

We do not need to care about ghosts at multiple call sites; they
cannot have a {blob} field and we've stored the blob field in
Xapian since SCHEMA_VERSION=13.

www: support cloning individual v2 git partitions

This will require multiple client invocations, but should reduce
load on the server and make it easier for readers to only clone
the latest data.

Unfortunately, supporting a cloneurl file for externally-hosted
repos will be more difficult as we cannot easily know if the
clones use v1 or v2 repositories, or how many git partitions
they have.

githttpbackend: avoid infinite loop on generic PSGI servers

We must detect EOF when reading a POST body with standard PSGI servers.
This does not affect deployments using the standard public-inbox-httpd;
but most smaller inboxes should be able to get away using a generic
PSGI server.

http: fix modification of read-only value

This fails in the rare case we get a partial send() on "\r\n"
when writing chunked HTTP responses out.

view: depend on SearchMsg for Message-ID

Since we need to handle messages with multiple and duplicate
Message-ID headers, our thread skeleton display must account
for that.

Since we have a "preferred" Message-ID in case of conflicts,
use it as the UUID in an Atom feed so readers do not get
confused by conflicts.

searchview: remove unnecessary imports from MID module

We do not need many of these, anymore.

www: get rid of unnecessary 'inbox' name reference

We use the actual Inbox object everywhere else and don't
need the name of the inbox separated from the object.

v2writable: warn on unseen deleted files

It would be a bug to have deleted files marked but not
seen in our histories.

searchidx: warn about vivifying multiple ghosts

This should help us detect bugs sooner in case we have
space waste problems.

view: permalink (per-message) view shows multiple messages

This needs tests and further refinement, but current tests pass.