lei: add some labels support

"lei q" now displays labels in JSON output, "lei mark"
can add or remove labels for any messages.

"lei ls-label" is supported, too.

Unfortunately, "lei q" won't hande "kw:" or "L:" for
external messages, they must be imported, first.

lei: _lei_store: use default even if unconfigured

Perhaps leistore.dir doesn't need to have a config file
entry if we're using the default location.

v2: "account for unconfigured leistore.dir" (on reuse)

lei_xsearch: wait for kw updates for non-threaded case, too

We'll also hoist wait_startq out of the per-message loops
since it's not worth having to check every single message
when filling in smsg info is reasonably fast, anyways.

t/lei: add more diagnostics for failures

This seems to error out while looping the test suite and
I'm not 100% sure why.

t/cmd_ipc: workaround signal handling raciness

Perl can't check for interrupts when inside a blocking syscall,
as there's no self-pipe mechanism inside Perl itself.  So fork
a child and have it repeated kill(2) instead of relying on alarm(3).

lei import: force store, improve test diagnostics

"lei import" should never be without a {sto}, and *_done should
not be called multiple times, so ensure we can fail if it's
missing.

Update some existing tests to complain loudly by introducing a
handy "xbail" function which wraps "explain" and BAIL_OUT.
BAIL_OUT was painful to type and concatenating the result of
"explain" doesn't work as I thought it would since "explain"
always returns an array, and BAIL_OUT only accepts a single
scalar arg (unlike "die").

tests: "check-run" uses persistent lei daemon

We'll use a lei-daemon if it's already running and
TEST_LEI_DAEMON_PERSIST_DIR is set, but we can also start
one and manage it from t/run.perl

This drops "make check-run TEST_LEI_DAEMON_ONLY=1"
time by ~10% for me.

t/*: drop unnecessary v1-specific index calls

Outside of mirrors, we can -init with indexlevel to avoid
calling -index explicitly.

lei_mirror: don't show success on failure

While we were exiting with a error code, showing a successful
"# mirrored $URL" message is misleading and wrong.  Don't show
success until everything is complete and the config is written.

lei add-external: do not initialize writable store

There's no need to create or write lei/store when adding
an external, we just need to write to the config file.

test_common: TEST_LEI_ERR_LOUD does not hide path names

We hide paths by default to reduce noise, but we want
noise with loud errors.

lei: janky $PATH2CFG garbage collection

We need to rely on this to keep our config cache (and lei_store
pipes) under control with tests each creating a new config and
directory.

test_common: cleanup inbox objects after use

This stops us from leaking some more file handles across
test cases.

lei-daemon: do not leak FDs on bogus requests

If a client passes us the incorrect number of FDs, we'll vivify
them into PerlIO objects so they can be auto-closed.  Using
POSIX::close was considered, but it would've been more code to
handle an uncommon case.

lei_mirror: fix circular reference

All of our $lei->workers_start callers can simply rely on
that wrapper to do the right thing and pass fields to
->wq_worker_start children, only.

This could manifest as a unbound memory growth if somebody is
constantly mirroring, and was causing tests to get stuck when
experimenting with a persistent lei-daemon for the entire
test suite.

v2writable: cleanup SQLite handles on --xapian-only

I'm not sure exactly why this is needed with run_script
localizing %SIG and everything else, but explictly cleaning up
seems to fix the occasional test failures I see.

Followup-to: 4c6c853494b49368 ("tests: show lsof output on deleted-file-check failures")

lei_store: give process a better name

We'll prioritize the last two components of the path name
("lei/store") since that's how I often refer to the on-disk
location.  Then, show the XDG_DATA_HOME it belongs to in case
a user changes HOME or XDG_* for testing purposes.

lei: clean up pkt_op consumer on exception, too

We need to consistently ensure pkt_op_c doesn't lead to a
long-lived circular reference if an exception is thrown in
pre_augment.  Maybe the API could be better, but this fixes an
FD leak when attempting to --augment a FIFO.

Followup-to: b9524082ba39e665 ("lei_xsearch: cleanup {pkt_op_p} on exceptions")

lei: update {3} after -C chdirs

This is necessary for lei->rel2abs correctness, and may
eventually be useful if we can use *at syscalls.

lei: drop circular reference in lei_store process

I'm not sure if this was causing real problems, but it's sure ugly.

mbox_lock: dotlock: chdir for relative lock paths

Since lei-daemon will fchdir on every request, we must ensure
we're in the correct directory before unlink(2) is called,
since we can't use unlinkat(2) from pure Perl.

ds: improve DS->Reset fork-safety

None of these fixes affect current public-inbox-* code, or even
normal uses of lei.  However, lei users wanting to switch
between $HOME directories or use alternate store paths may
notice strange behavior and this fixes some of it.

We'll also loop to account for DESTROY callbacks inserting into
container objects and retry appropriately.

lei: improve management around short-lived workers

Instead of creating a short-lived circular reference,
ensure they don't exist in the first place.

Note the following changes to hold an extra ref to $sto:

- $self->_lei_store(1)->write_prepare($self);
+ my $sto = $self->_lei_store(1);
+ $sto->write_prepare($self);

I'm not a perlguts expert, but I actually wanted to switch
to the one-line version for LeiImport, but xt/lei-auth-fail.t
was getting stuck for some reason.  It seems the extra ref
to the LeiStore ($sto) object is necessary.

lei_input: more common code between <mark|convert|import>

"lei convert" is actually a bit of the odd one, since
it uses lei2mail for auth, unlike the others.

lei: persistent workers (lei_store) run in /

Since each lei->event_step can change the directory of
lei-daemon, we need to ensure the lei_store runs in a
directory that is stable.

test_common: check lei/errors.log

This will make it easier to diagnose some large internal
rewrites.

net_reader: nntp_each: pass keywords as `undef'

We'll use `undef' to denote keywords are unknown/unsupported,
instead of an empty arrayref.

This will let callers use the same callback and args for
imap_each.  Passing an empty arrayref to set_eml in LeiStore
causes keywords to be cleared completely, which is not desired
behavior when "lei import" is importing already-seen messages
from NNTP.

lei: hide *_atfork_child from command-line

Otherwise we could get non-sensical results if somebody tries
running "lei atfork_child" from the command-line.

lei mark: add support for (bash) completion

Only lightly tested, this seems to suffer from the same
problem as external completions for network URLs with
colons in them.  In any case, its usable enough for me.

The core LEI module now supports completions for lazy-loaded
commands, too, so we'll be able to do completions for other
commands more easily.

lei mark: command for (un)setting keywords and labels

Only tested for keywords and labels with file inputs, so far;
but it seems to do what it needs to do.  There's a bit more
redundant code than I'd like, and more opportunities for code
sharing in the future

"lei import" will be expanded to support +kw:$KEYWORD and
+L:$LABEL in the future.

lei import: ignore Status headers in "eml" messages

Those headers only have meaning with for mboxes.  Don't surprise
users by trying to make sense of a header that is defined for mboxes.

It's possible to send email with (Status|X-Status) headers and
have those headers show up in a recipient's IMAP mailbox.

This was bad because an IMAP user may want to import a single
message through their MUA and pipe its contents to "lei import"
without noticing a mischievious sender stuck "X-Status: F"
(flagged/important) in there.

lei_input: drop "From " line on single "eml" (message/rfc822)

This matches the long-standing behavior of public-inbox-mda,
public-inbox-learn and our other tools.  It is useful because
mutt, "git format-patch", and likely other tools will
pipe a single message with a "From " header line, but with
no further "From " escaping or Content-Length: header.

lei_input: common filehandle reader for eml + mbox

This improve code regularity, and will let us deal with
the "RFC822" messages with "From " line that mutt pipes
to.

mbox_reader: add ->reads method to avoid nonsensical formats

Relying on UNIVERSAL::can may cause internal helper methods
to be used, which can lead to failures or nonsensical results.

lei: simplify workers_start and callers

Since workers_start is in the common PublicInbox::LEI
package, we can just use \&METHOD_NAME instead of relying
on UNIVERSAL->can to avoid a method dispatch.

Most of our worker code can just use lei->dclose, so default
to doing that unless it's been overridden.

lei: share input code between convert and import

These commands accept mail the same way, and this forces
us to maintain consistent input format support between
commands.

We'll be using this for "lei mark", too.

net_reader: escape nasty chars from Net::NNTP->message

Net::Cmd::message (used by Net::NNTP) does no escaping at all,
so "\r" was causing confusing/nonsensical error messages when
I tried to import from the wrong group.

lei: support -c <name>=<value> to overrides

It's a bit nasty, but seems to mostly work for debugging
IMAP and NNTP commands.

lei: simplify lazy-loading

This makes it slightly easier to implement future commands,
since there'll be a couple more relatively self-contained
ones.

lei: fix some warnings in tests

And then test the contents of $lei_err to ensure it doesn't
happen again.

We'll also make MboxLock emit nicer warnings without the line
number, since the line number is irrelevant to the user fixing
an mbox lock contention problem.

Finally, we'll also allow showing loud warnings via
TEST_LEI_ERR_LOUD=1

lei q: fix warning on remote imports

This will let us tie keywords from remote externals
to those which only exist in local externals.

lei import: vivify external-only messages

Keyword storage for external-only messages was preventing
messages from being explicitly imported.  Teach lei_store
to vivify keyword-only entries into fully-indexed messages
on import.

searchview: collapse Message-ID links in summary

There's no point in showing duplicate links to the same
Message-ID in summary view.  The per-message page will
note the duplication (if any) separately.

Reported-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Link: https://public-inbox.org/meta/20210317132723.xx4klonordhsb6ve@chatter.i7.local/

lei q: trim JSON output

Stop showing `docid' since it's not useful with shards.

`bytes' and `lines' are probably noise, but maybe could be
visible in some "fuller" view.

v2: t/lei_xsearch: fix warnings from {docid} removal

lei: tie ALE lifetime to config file

This should make a future change to "lei import" work more
nicely, since we'll be needing ALE to vivify external-only
messages upon explicit "lei import".

lei_to_mail: match mutt order of status headers

These changes may make it easier to do byte-for-byte comparisons
with mail copied out of mutt, a popular MUA for our target
audience.

mutt currently outputs the 'R' (seen) flag before the 'O'
character in the Status: header.  We'll assume that stays
the case (it has been for a while).

Status now comes before X-Status, also matching mutt behavior.

lei q: put keywords on one line in --pretty output

Don't waste precious terminal space when there are only a small
number of possible keywords supported/reserved for JMAP.  In the
future, we may implement more sophisticated wrapping for labels,
but it we'll cross tha bridge when we come to it.

lei q: support vmd for external-only messages

"lei q" now preserves changes per-message keywords across
invocations when it's --output (Maildir or mbox) is reused
(with or without --augment).

In the future, these changes will be monitored via inotify,
EVFILT_VNODE or IMAP IDLE, too.

Unfortunately, this currently prevents "lei import" from ever
importing a message that's in an external.  That will be fixed
in a future change.

lei: All Local Externals: bare git dir for alternates

This will be used for keyword (and label) storage for externals.
We'll be using this to ensure we don't redundantly auto-import
messages into lei/store if they're already in a local external
(they can still be imported explicitly via "lei import").

lei_store: initialize IPC lock properly

This was causing errors in a mass keyword import patch
I'm working on.

maildir: avoid redundant slashes

Redundant slashes look ugly in strace(1) output.

lei q: -I/--include overrides --no-(external|local|remote)

Assume that anybody using -I/--include for external locations
will want to override --no-$FOO if they're explicitly including
a location.

With some effort, we could make it order-dependent (e.g.
"-I $LOCATION --no-$FOO" and "--no-$FOO -I $LOCATION"
behave differently).  However that's not straightforward
when using Getopt::Long to parse command-line options into
a hashref.

I'm also not sure if order-dependent switches are a desirable
UI/UX quality.

config: ignore extindex entries with newlines in paths

git 2.11 and earlier could not handle git directories with
newlines in them, nor does libgit2 support them.

Followup-to: d87dd0e679587043 ("config: reject `\n' in `inboxdir'")

lei: disallow "\n" in local externals paths

git 2.11 and earlier could not handle git directories with
newlines in them, nor does libgit2 support them.

Followup-to: d87dd0e679587043 ("config: reject `\n' in `inboxdir'")

xt/create-many-inboxes: adjust for detect_nproc, no fsync

detect_nproc is in the IPC module, now; and we can safely
disable fsync when creating test data.
And "modernize" up to 5.10.1 while we're at it.

The use fsync was causing this to run for hours instead
of minutes since I forgot to use eatmydata.

doc: glossary: add missing over/back POD directives

Oops :x

lei_overview: unnecessary g2m capture

Nothing like the -Wunused C compiler flag in perl, AFAIK...

examples: cgit-commit-filter: drop <tt> HTML tag, use title=

<tt> doesn't seem necessary and it's deprecated in HTML, nowadays.
In any case, dillo's CSS support seems to show it as fixed-width
even without <tt>.  Use the title= attribute to highlight that
it goes to the mail thread, too.

In the future, we'll probably link to something like "lei p2q"
(patch-to-query) to include OIDs in the search.

cgit: fix fallout from lazy coderepo loading

We can't completely instantiate our cgit wrapper without knowing
knowing cgit locations for serving static content.

Fixes: a5968dc059f655a ("config: lazy-load coderepos, support extindex")

lei_store: keywords => vmd (volatile metadata), prepare for labels

Since keywords and mailboxes (AKA labels) are separate things in
JMAP; and only keywords can map reliably to Maildir and mbox;
we'll keep them separate in our internal data representations,
too.

I initially wanted to call this just "meta" for "metadata", but
that might be confused with our mailing list name.  "metadata"
is already used in Xapian's own API, to add another layer of
confusion.

"tags" was also considered, but probably confusing to notmuch
users since our "labels" are analogous to "tags" in notmuch,
and notmuch doesn't seem to cover "keywords" separately...

So "vmd" it is, since we haven't used this particular
three-letter-abbreviation anywhere before; and "volatile" seems
like a good description of this metadata since everything else
up to this point has been mostly WORM (write-once, read-many).

tests: show lsof output on deleted-file-check failures

This may help track down some occasional test failures I'm
seeing.

www: improve visibility of coderepos

By adding "+code" next to "mirror" at the top next to the search
box.  Instead of showing "/path/to/$FOO", showing "$FOO.git"
makes it more obvious we're talking about a git repo, here,
instead of some random directory.

config: lazy-load coderepos, support extindex

Extsearch objects are duck-types of Inbox objects, and
are capable of supporting code repos all the same.

extindex: add some validation and config knobs for WWW

We'll try to share a bit more configuration with
extindex entries for WWW PSGI usage.

www_stream: add trailing slash for help and color links

This saves clients a redirect

eml: decode Bcc, and Resent-* address variants

This is closer to matching RFC 8621 section 4.1.2.3,
though we don't support the "Any header field not defined in
RFC5322 or RFC2369" rule, since that could get tricky...

lock: remove new_tmp method

Unused as of commit dda8237aeb5722b3a48c31896d9b7398e50823f1
("lei_to_mail: prepare for worker offload") when we switched
to using the LeiOverview output lock.

git: drop async_prefetch method

That logic is inlined directly into git_async_prefetch
in GitAsyncCat and I don't see it being useful outside
of a DS event loop.

nntp: remove unused header_append method

It was unused since 1bf653ad139bf7bb3d853ab0b5eae3eaa1b13a95
("nntp+www: drop List-* and Archived-At headers")

lei_store: remove maildir_keywords

It's redundant and the same functionality is in MdirReader.

mbox: move mbox_keywords to MboxReader

MboxReader is a more appropriate place for it than LeiStore.

t/*: disable fsync on tests were create_inbox isn't worth it

Using create_inbox doesn't seem worth the trouble, here, at the
moment, but disabling fsync(2) gives a noticeable speedup on
my system even with an SSD.

t/altid_v2: create_inbox

Another 100ms saved

t/thread-index-gap: create_inbox

Yes, this loses some randomness w.r.t. shuffle, but I
think it's "good enough" and buys us ~100ms speedup on
an SSD TMPDIR.

t/nntpd: use create_inbox

t/nntpd-tls: use create_inbox

Another 100ms or so saved.

t/miscsearch: use create_inbox

t/psgi_search: use create_inbox

t/multi-mid: use create_inbox

t/indexlevels-mirror: use create_inbox

This saves hundreds of milliseconds and reduces LoC.

t/lei_xsearch: use create_inbox

This ends up being significantly faster when confined
to a slow TMPDIR.

t/inbox_idle: switch to create_inbox

Surprising to me, this is actually significantly faster
even though we're starting off with an empty inbox due
to -no_fsync being the default.

t/edit: switch to create_inbox

Hardly any time reduction, but code gets more compact.

t/cgi: create_inbox

This only saves a few ms but is nicer to look at.

t/solver_git: use create_inbox

This saves us a dozen or so milliseconds.

t/imapd: create_inbox (minor)

This saves over 100ms.

t/psgi_v2: create_inbox

Some lines of code and a dozen milliseconds dealth with.

t/psgi_scan_all: create_inbox lots saved

A fair mount of setup code goes away and saves us a few
hundred milliseconds.

t/psgi_multipart_not: use create_inbox

Over 100ms saved.

t/psgi_bad_mids: use create_inbox

Over 100ms saved and it's less code to boot.

t/feed: switch to create_inbox

This only saves a few milliseconds, but is less code.

t/psgi_mount: switch to create_inbox

A few dozen more milliseconds saved.

t/altid: use create_inbox

Another few dozen milliseconds saved.

t/convert-compact: create_inbox

Suprisingly, this saves over 100 milliseconds.

t/httpd: convert to create_inbox

No real difference, here, but having less code is nice.

t/psgi_attach: convert to create_inbox

Another few dozen milliseconds saved.

t/plack: use create_inbox

Only a few dozen milliseconds saved, but better than nothing.

t/html_index: remove now-worthless test

This was for quote-folding behavior we had long ago, but
it ended up just being yet another import test.

t/admin: switch to create_inbox

Over 100ms saved.

v2: quiet down "git gc" warnings on empty inboxes

t/v2dupindex: create_inbox

Another hundred milliseconds or so saved.