solver: rewrite to use Qspawn->psgi_qx and pi-httpd.async

The psgi_qx routine in the now-abandoned "repobrowse" branch
allows us to break down blob-solving at each process execution
point.  It reuses the Qspawn facility for git-http-backend(1),
allowing us to limit parallel subprocesses independently of Perl
worker count.

This is actually a 2-3% slower a fully-synchronous execution;
but it is fair to other clients as it won't monopolize the server
for hundreds of milliseconds (or even seconds) at a time.

view: swap CRLF for LF in HTML output

It makes no difference to browsers aside from saving a few
bytes; and this means we won't have to worry about extra
'%0D' showing up in links to solver.

t/qspawn.t: psgi_qx stderr test

qspawn: implement psgi_qx

This new asynchronous API, will allow us to take
advantage of non-blocking I/O from even small commands;
as those may still need to wait for slow operations.

httpd/async: stop running command if client disconnects

If an HTTP client disconnects while we're piping the output of a
process to them, break the pipe of the process to reclaim
resources as soon as possible.

qspawn|httpd/async: improve and fix out-of-date comments

qspawn|getlinebody: support streaming filters

This is intended for wrapping "git show" and "git diff"
processes in the future and to prevent it from monopolizing
callers.

This will us to better handle backpressure from gigantic
commits.

qspawn: implement psgi_return and use it for githttpbackend

Was: ("repobrowse: port patch generation over to qspawn")

We'll be using it for githttpbackend and maybe other things.

httpd/async: remove needless sysread wrapper

We don't appear to be using it anywhere

t/check-www-inbox: trap SIGINT for File::Temp destruction

Otherwise, temporary GDBM files don't get unlinked
when I SIGINT the process.

hval: split out escape sequences to a separate table

We'll want to handle those escape sequences independently,
"highlight" already does HTML escaping.

highlight: initial wrapper and PSGI service

I'll probably expose the PSGI service for cgit;
but it could be useful to others as well.

t/check-www-inbox: warn on missing Content-Type

Oops, I might've left it out, somewhere.

config: each_inbox iteration preserves config order

For cross-inbox Message-ID resolution; having some sort of
stable ordering makes the most sense.  Relying on the
order of the config file seems most natural and allows us
to avoid introducing yet another configuration knob.

solver: remove extra "^index $OID..$OID" line

It was harmless, besides wasting space and memory.

solver: force quoted-printable bodies to LF

..if the Email::MIME ->crlf is LF.

Email::MIME::Encodings forces everything to CRLF on
quoted-printable messages for RFC-compliance; and
git-apply --ignore-whitespace seems to miss a context
line which is just "\r\n" (w/o leading space).

viewvcs: disable white-space prewrap in blob view

We need to keep line-numbers from <a> tags synced to the actual
line numbers in the code when working in smaller viewports.

Maybe I only work on reasonable projects, but excessively
long lines seem to be less of a problem in code than they are
in emails.

viewdiff: do not link to 0{7,40} blobs (again)

We must reset diff context when starting a new file;
and we must check for all-zeroes object_ids as the
post-image correctly.

t/check-www-inbox: use xmlstarlet to validate Atom if available

I almost forgot about this script; but remembering to test
it against real-world data can be useful to hunt for bugs.

viewdiff: quote attributes for Atom feed

We still need to use XHTML the Atom feed, and XHTML requires
attributes to be quoted, whereas HTML 5 does not.

viewdiff: cleanup state transitions a bit

This makes things less error-prone and allows us to only
highlight the "@@ -\S+ \+\S+ @@" part of the hunk header
line, without highlighting the function context.

This more closely matches the coloring behavior of git-diff(1)

viewdiff: support diff-highlighting w/o coderepo

Having diff highlighting alone is still useful, even
if blob-resolution/recreation is too expensive or
unfeasible.

$INBOX/_/text/color/ and sample user-side CSS

Since we now support more CSS classes for coloring,
give this feature more visibility.

www: admin-configurable CSS via "publicinbox.css"

Maybe we'll default to a dark theme to promote energy savings...

See contrib/css/README for details

solver: restore diagnostics and deal with CRLF

Apparently Email::MIME returns quoted-printable text
with CRLF.  So use --ignore-whitespace with git-apply(1)
and ensure we don't capture '\r' in pathnames from
those emails.

And restore "$@" dumping when we die while solving.

view: enforce trailing slash for /$INBOX/$OID/s/ endpoints

As with our use of the trailing slash in $MESSAGE_ID/T/ and
'$MESSAGE_ID/t/' endpoints, this for 'wget -r --mirror'
compatibility as well as allowing sysadmins to quickly stand up
a static directory with "index.html" in it to reduce load.

solver: add a TODO note about making this fully evented

Applying a 100+ patch series can be a pain and lead to a wayward
client monopolizing the connection.  On the other hand, we'll
also need to be careful and limit the number of in-flight file
descriptors and parallel git-apply processes when we move to an
evented model, here.

solver: note the synchronous nature of index preparation

It's not likely to be worth our time to support
a callback-driven model for something which happens
once per patch series.

solver: break @todo loop into a callback

This will allow each patch search via Xapian to "yield" the
current client in favor of another client in the PSGI web
interface for fairness.

solver: simplify control flow for initial loop

We'll be breaking this up into several steps, too; since
searching inboxes for patch blobs can take 10s of milliseconds
for me.

solver: switch patch application to use a callback

A bit messy at the moment, but we need to break this up
into smaller steps for fairness with other clients, as
applying dozens of patches can take several hundred
milliseconds.

solver: break up patch application steps

We want more fine-grained scheduling for PSGI use, as
the patch application step can take hundreds of milliseconds
on my modest hardware

solver: more verbose blob resolution

Help users find out where each step of the resolution came from.
Also, we must clean abort the process if we have missing blobs.

And refine the output to avoid unnecessary braces, too.

git: support 'ambiguous' result from --batch-check

David Turner's patch to return "ambiguous" seems like a reasonable
patch for future versions of git:

https://public-inbox.org/git/672a6fb9e480becbfcb5df23ae37193784811b6b.camel@novalis.org/

view: enable naming hints for raw blob downloads

Meaningful names in URLs are nice, and it can make
life easier for supporting syntax-highlighting

solver: operate directly on git index

No need to incur extra I/O traffic with a working-tree and
uncompressed files on the filesystem.  git can handle patch
application in memory and we rely on exact blob matching
anyways, so no need for 3way patch application.

git: disable abbreviations with cat-file hints

Ambiguity is not worth it for internal usage with the
solver.

view: wire up diff and vcs viewers with solver

solver: various bugfixes and cleanups

Remove the make_path dependency and call mkdir directly.
Capture mode on new files, avoid referencing non-existent
functions and enhance the debug output for users to read.

git: check saves error on disambiguation

This will be useful for disambiguating short OIDs in older
emails when abbreviations were shorter.

Tested against the following script with /path/to/git.git
==> t.perl <==
use strict;
use PublicInbox::Git;
use Data::Dumper;
my $dir = shift or die "Usage: $0 GIT_DIR # (of git.git)";
my $git = PublicInbox::Git->new($dir);
my @res = $git->check('dead');
print Dumper({res => \@res, err=> $git->last_check_err});
@res = $git->check('5335669531d83d7d6c905bcfca9b5f8e182dc4d4');
print Dumper({res => \@res, err=> $git->last_check_err});

git: add git_quote

It'll be helpful for displaying progress in SolverGit
output.

git: support multiple URL endpoints

For redundancy and centralization resistance.

solver: initial Perl implementation

This will lookup git blobs from associated git source code
repositories.  If the blobs can't be found, an attempt to
"solve" them via patch application will be performed.

Eventually, this may become the basis of a type-agnostic
frontend similar to "git show"

t/perf-msgview: add test to check msg_html performance

This will be necessary to ensure we maintain reasonable
performance when we add diff-highlighting support.

hval: force monospace for <form> elements, too

Same reasoning as commit 7b7885fc3be2719c068c0a2fc860d53f17a1d933,
because GUI browsers have a tendency to use a different
font-family (and thus different size) as the rest of the page.

view: disable bold in topic display

It seems pointless due to the indentation, and interacts
badly with some CSS colouring.

t/git.t: do not pass "-b" to git-repack(1)

Allows t/git.t to run on older versions of git without
"-b" and avoids incurring extra I/O traffic for bitmaps.

git: git_unquote handles double-quote and backslash

We need to work with 0x22 (double-quote) and 0x5c (backslash);
even if they're oddball characters in filenames which wouldn't
be used by projects I'd want to work on.

t/git.t: avoid passing read-only value to git_unquote

Older versions of Perl (tested 5.14.2 on Debian wheezy(*),
reported by Konstantin on Perl 5.16.3) considered the result of
concatenating two string literals to be a constant value.

(*) not that other stuff works on wheezy, but t/git.t should.

Reported-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>

nntp: header responses use CRLF consistently

Alpine is apparently stricter than other clients I've tried
w.r.t. using CRLF for headers.  So do the same thing we do for
bodies to ensure we only emit CRLFs and no bare LFs.

Reported-by: Wang Kang <i@scateu.me>
  https://public-inbox.org/meta/alpine.DEB.2.21.99.1901161043430.29788@la.scateu.me/

config: inbox name checking matches git.git more closely

Actually, it turns out git.git/remote.c::valid_remote_nick
rules alone are insufficient.  More checking is performed as
part of the refname in the git.git/refs.c::check_refname_component

I also considered rejecting URL-unfriendly inbox names entirely,
but realized some users may intentionally configure names not
handled by our WWW endpoint for archives they don't want
accessible over HTTP.

git_unquote: perform modifications in-place

This function doesn't have a lot of callers at the moment so
none of them are affected by this change.  But the plan is to
use this in our WWW code for things, so do it now before we
call it in more places.

Results from a Thinkpad X200 with a Core2Duo P8600 @ 2.4GHz:

Benchmark: timing 10 iterations of cp, ip...
        cp: 12.868 wallclock secs (12.86 usr +  0.00 sys = 12.86 CPU) @  0.78/s (n=10)
        ip: 10.9137 wallclock secs (10.91 usr +  0.00 sys = 10.91 CPU) @  0.92/s (n=10)

Note: I mainly care about unquoted performance because
that's the common case for the target audience of public-inbox.

Script used to get benchmark results against the Linux source tree:
==> bench_unquote.perl <==
use strict;
use warnings;
use Benchmark ':hireswallclock';
my $nr = 50;

my %GIT_ESC = (
a => "\a",
b => "\b",
f => "\f",
n => "\n",
r => "\r",
t => "\t",
v => "\013",
);

sub git_unquote_ip ($) {
return $_[0] unless ($_[0] =~ /\A"(.*)"\z/);
$_[0] = $1;
$_[0] =~ s/\\([abfnrtv])/$GIT_ESC{$1}/g;
$_[0] =~ s/\\([0-7]{1,3})/chr(oct($1))/ge;
$_[0];
}

sub git_unquote_cp ($) {
my ($s) = @_;
return $s unless ($s =~ /\A"(.*)"\z/);
$s = $1;
$s =~ s/\\([abfnrtv])/$GIT_ESC{$1}/g;
$s =~ s/\\([0-7]{1,3})/chr(oct($1))/ge;
$s;
}

chomp(my @files = `git -C ~/linux ls-tree --name-only -r v4.19.13`);
timethese(10, {
cp => sub { for (0..$nr) { git_unquote_cp($_) for @files } },
ip => sub { for (0..$nr) { git_unquote_ip($_) for @files } },
});

searchidx: move git_unquote to PublicInbox::Git

We'll be using it outside of searchidx...

index: allow working on unconfigured inboxes, again

HACKING: update Debian version information

It's been a few years since this was updated...

Merge commit 'mem'

* commit 'mem':
  view: more culling for search threads
  over: cull unneeded fields for get_thread
  searchmsg: remove unused fields for PSGI in Xapian results
  searchview: drop unused {seen} hashref
  searchmsg: remove Xapian::Document field
  searchmsg: get rid of termlist scanning for mid
  httpd: remove psgix.harakiri reference

t/v2writable.t: force more consistent "git log" output

This should probably use lower-level git plumbing, but until
then, consistently add a bunch of --no-* options to "git log"
to get more consistent output.

Noticed-by: Johannes Berg
  https://public-inbox.org/meta/1538164205.14416.76.camel@sipsolutions.net/

check git version requirements

This allows v1 tests to continue working on git 1.8.0 for
now.  This allows git 2.1.4 packaged with Debian 8 ("jessie")
to run old tests, at least.

I suppose it's safe to drop Debian 7 ("wheezy") due to our
dependency on git 1.8.0 for "merge-base --is-ancestor".

Writing V2 repositories requires git 2.6 for "get-mark"
support, so mask out tests for older gits.

INSTALL: Net::Server is not needed for systemd use

Also, move Socket6 down since it's usually pulled in as
a dependency of Net::Server or SpamAssassin; and we can
fail gracefully without it.

daemon: make Socket6 optional, note about Net::Socket::IP

It looks like Net::Socket::IP comes with Perl 5.20 and
later; so we won't have to hassle users with another
package to install.

doc: various overview-level module comments

Hopefully this helps people familiarize themselves with
the source code.

INSTALL: fix Date::Parse dependency for Debian

So yes, both "libdatetime-perl" and "libtimedate-perl" exist
in Debian.  We want the latter for the Date::Parse module.

(And the former pulls in THIRTY-SEVEN dependencies on a fresh
 sid chroot, ohg yrsgcnq vf abg bar bs gurz).

view: more culling for search threads

{mapping} overhead is now down to ~1.3M at the end of
a giant thread from hell.

over: cull unneeded fields for get_thread

On a certain ugly /$INBOX/$MESSAGE_ID/T/ endpoint with 1000
messages in the thread, this cuts memory usage from 2.5M to 1.9M
(which still isn't great, but it's a start).

searchmsg: remove unused fields for PSGI in Xapian results

These fields are only necessary in NNTP and not even stored in
Xapian; so keeping them around for the PSGI web UI search
results wastes nearly 80K when loading large result sets.

searchview: drop unused {seen} hashref

Unused since commit 5f09452bb7e6cf49fb6eb7e6cf166a7c3cdc5433
("view: cull redundant phrases in subjects")

searchmsg: remove Xapian::Document field

We don't need to be carrying this around with the many SearchMsg
objects we have.  This saves about 20K from a large SearchView
"&x=t" response.

searchmsg: get rid of termlist scanning for mid

It doesn't seem to be used anywhere

httpd: remove psgix.harakiri reference

We don't need to set "psgix." extension fields for things
we don't support.  This saves 138 bytes per-client in $env
as measured by Devel::Size::total_size

view: fix wrong date for non-Xapian/SQLite v1 users

We need to parse the MIME object in order to get the
datestamp for those sites.

Fixes: 7d02b9e64455 ("view: stop storing all MIME objects on large threads")

nntp: fix uninitialized variable in event_read

do_write must return 0 or 1.

view: stop storing all MIME objects on large threads

While we try to discard the $smsg (SearchMsg) objects quickly,
they remain referenced via $node (SearchThread::Msg) objects,
which are stored forever in $ctx->{mapping} to cull redundant
words out of subjects in the thread skeleton.

This significantly cuts memory bloat with large search results
with '&x=t'.  Now, the search results overhead of
SearchThread::Msg and linked objects are stable at around 350K
instead of ~7M per response in a rough test (there's more
savings to be had in the same areas).

Several hundred kilobytes is still huge and a large per-client
cost; but it's far better than MEGABYTES per-client.

t/mda_filter_rubylang.t: set PI_EMERGENCY for -mda

Tests should not write to the default ~/.public-inbox/emergency

shrink low-bandwidth pipes under Linux

I've hit /proc/sys/fs/pipe-user-pages-* limits on some systems.
So stop hogging resources on pipes which don't benefit from
giant sizes.

Some of these can use eventfd in the future to further reduce
resource use.

index: quiet down git-log error messages on new inboxes

The new t/*filter_rubylang.t tests call -index immediately
after -init, which causes confusing messages to show up to
the end user.

Check the validity of the ref before calling "git-log".

filter/rubylang: fix SQLite DB lifetime problems

Clearly the AltId stuff was never tested for v2.  Ensure
this tricky filter (which reuses Msgmap to avoid introducing
new serial numbers) doesn't trigger deadlocks SQLite due
to opening a DB for writing multiple times.

I went through several iterations of this change before
going with this one, which is the least intrusive I could
fine.

inboxwritable: drop unused variable

watchmaildir: normalize Maildir pathnames consistently

Remove redundant slashes while we're at it.

watchmaildir: get rid of unused spamdir field

Unused since commit 6c2caa791bd5fbf5c4edb1a4a2c1807e527348a7
("watchmaildir: support v2 repositories")

watchmaildir: support multiple inboxes in the same Maildir

Not sure what I was smoking when I originally wrote this code.

cf. https://public-inbox.org/meta/874li887mp.fsf@vuxu.org/

t/cgi.t: remove more redundant tests

Most of these test cases are in t/plack.t, already; and that
runs much faster.  Just ensure the slashy corner case and search
stuff works.  While we're at it, avoid using the
public-inbox-index command and just use the internal API to
index.

t/cgi.t: move expected failure tests to t/plack.t

No point in implementing these slowly with the CGI wrapper
when PSGI is sufficient for testing.

t/cgi.t: move dumb HTTP git clone/fetch tests to plack.t

No need to test this via CGI .cgi is a wrapper around
PSGI and PSGI tests are way faster.

t/cgi.t: remove atom.xml test

It is redundant with what is in t/plack.t

t/cgi.t: remove redundant redirect check

t/plack.t already has the same test.

t/cgi.t: eliminate some cruft and unnecessary tests

More of this test will be, we use PSGI nowadays; and
most of these tests can be ported over to use PSGI and
not fork+exec as much.

v2writable: disable parallelism on indexlevel=basic

There is no need for parallelism if we're not using Xapian.

config: relax name inbox name restrictions

Since "publicinbox" sections are analogous to git remotes, we
may use the same rules for naming git remotes to reduce
cognitive overhead.

Most notably, this allows '.' in the middle of inbox names,
(e.g. "foo.bar") as it's common for email addresses, too.

use PublicInbox::Config::each_inbox where appropriate

No need to reach into PublicInbox::Config internals and iterate
through the hashref by hand

update and add documentation for repository formats

Remove confusing documentation around ssoma now that we
have NNTP and downloadable mbox support.

Only lightly-checked for grammar and speling, and not yet
formatting.  Edits, corrections and addendums expected :>

t/feed.t: remove ssoma use

No need to waste cycles with this anymore.

t/v2reindex: use the larger text to increase test reliability

libxapian30:amd64 1.4.9-1 on Debian sid seems to give an 8KB
position.glass database with "hello world" as the document
regardless of our indexlevel.  Use the text of the AGPL-3.0 for
a more realisitic Xapian database size.

And perhaps tying our tests to the AGPL will make life more
difficult for would-be copyright violators :>

INSTALL: note Plack and URI::Escape are required at the moment

They really shouldn't be...  Also, it seems like eliminating IPC::Run
is not going to be worth the effort.

inbox: keep Danga::Socket optional

We can't run cleanup stuff without Danga::Socket.

hval: set font-size:100% for all elements

GUI browsers have a tendency to use a larger (though sometimes
smaller) font than the rest of the page for some reason I could
not find...

So set everything to 100% to give uniformity to the page; which
benefits visually-challenged users who want to use gigantic
fonts for the entire page.

TODO: avoid mentioning untrustworthy browser extensions

Old and new versions of Mozilla-based browsers seem to support
userContent.css just fine.

cf. https://www-archive.mozilla.org/unix/customizing.html#usercss
    http://kb.mozillazine.org/index.php?title=UserContent.css

TODO: support integration with cgit/gitweb/etc...

We support searching on blob identifiers for a reason :>

TODO: add a note for exposing a targeted reindexing API

handle "multipart/mixed" messages which are not multipart

I've found two examples on https://lore.kernel.org/lkml/
where the messages declared themselves to be "multipart/mixed"
but were actually plain text:

<87llgalspt.fsf@free.fr>
<200308111450.h7BEoOu20077@mail.osdl.org>

With the mboxrd downloaded, mutt is able to view them without
difficulty.

Note: this change would require reindexing of Xapian to pick up
the changes.  But it's only two ancient messages, the first was
resent by the original sender and the second is too old to be
relevant.

examples/cgit-commit-filter.lua: escape '&' properly in URL