config: tiny cleanup to use _array() sub

qspawn: documentation updates

This will become critical for future changes to display
git commits, diffs, and trees.

Use "qspawn.wcb" instead of "qspawn.response" to enhance
readability.

inbox: drop psgi.url_scheme requirement from base_url

This will make it easier to make command-line tools
from SolverGit.

viewvcs: support streaming large blobs

Forking off git-cat-file here for streaming large blobs is
reasonably efficient, at least no worse than using
git-http-backend for serving clones.  So let our limiter
framework deal with it.

git itself isn't great for large files, and AFAIK there's no
stable/widely-available mechanisms for reading smaller chunks
of giant blobs in git itself.

Tested with some giant GPU headers in the Linux kernel.

solvergit: allow shorter-than-necessary OIDs from user

We can rely on git to disambiguate, here; because sometimes
shorter OIDs can be unambiguous even if we only resolved the
longer one.

solvergit: allow searching on longer-than-needed OIDs

public-inbox can only index the abbreviated object_ids in
emails, not the full or even longer-than-necessary object_ids.
So retry failed object_ids if they're longer than 7 hex
characters.

inbox: perform cleanup of Git objects for coderepos

Otherwise, long-running but idle git processes may keep unlinked
packs around indefinitely and waste disk space.

t/config.t: test PublicInbox::Git sharing between inboxes

We need to ensure we don't introduce unnecessary processes
and memory usage for mapping multiple inboxes to the same
code repos.

doc/config: document coderepo and css bits

New features ought to be documented

solvergit: don't confuse Xapian with ".." in filenames

Xapian will interpret ".." as ranges, even quoted phrases.
So break up words on ".." since punctuation (AFAIK) is not
searchable, anyways.

git: use "git rev-parse --git-path"

Using git worktrees was causing t/solver_git.t to fail on me.

Merge remote-tracking branch 'origin/viewvcs' into master

* origin/viewvcs: (66 commits)
  solvergit: deal with alternative diff prefixes
  solvergit: extract mode from diff headers properly
  solvergit: avoid "Wide character" warnings
  solvergit: do not show full path names to "git apply"
  css/216dark: add comments and tweak highlight colors
  viewvcs: avoid segfault with highlight.pm at shutdown
  solvergit: do not solve blobs twice
  t/check-www-inbox: disable history
  t/check-www-inbox: don't follow mboxes
  t/check-www-inbox: replace IPC::Run with PublicInbox::Spawn
  hval: add src_escape for highlight post-processing
  viewvcs: wire up syntax-highlighting for blobs
  hlmod: disable enclosing <pre> tag
  t/hl_mod: extra check to ensure we escape HTML
  wwwhighlight: read_in_full returns undef on errors
  solver: crank up max patches to 9999
  viewvcs: do not show final error message twice
  qspawn: decode $? for user-friendliness
  solver: reduce "git apply" invocations
  solver: hold patches in temporary directory
  ...

view: remove unused _msg_date sub

Not needed since commit 956abe9ad5f13a0d1755262be412d6a54fda72e9
("view: depend on SearchMsg for Message-ID")

httpd: a few comments about some fields we set

Removing 'psgix.input.buffered' could be a possibility in
the future.

solvergit: deal with alternative diff prefixes

At least, without extra directory levels, since
git-diff supports --src-prefix and --dst-prefix,
and /git/6aa8857a11/s/ uses it...

solvergit: extract mode from diff headers properly

grep() won't set $1, so use "=~", instead.

solvergit: avoid "Wide character" warnings

Just quiet Perl down, since we don't know or care about the
encoding of the patch we hand off to git-apply.

solvergit: do not show full path names to "git apply"

"git apply" will warn about whitespace with the full path of the
patch, which will expose the $TMPDIR environment to users over
HTTP(S).

This change breaks compatibility with git pre-1.8.5, again;
but that was released in late-2013; so hopefully everybody
is on newer versions.

css/216dark: add comments and tweak highlight colors

Overkill, but "highlight" supports single-line comments (slc)
independently of multi-line comments (com); but we'll use the
same color for that.

We'll also use #0f0 instead of #0ff for "kwb" (keyword class "b")
since blue shades are prevalent in <a> links and comments, while
green was unused.

viewvcs: avoid segfault with highlight.pm at shutdown

Proper ordering of destruction seems required to avoid segfaults
at shutdown.

solvergit: do not solve blobs twice

In some cases, a file may ping-pong between blob IDs in the same
message when reverts occur.  So break out of this early.

This doesn't account for different abbreviations, but the
limited variations of abbreviations should alleviate the
problem.

t/check-www-inbox: disable history

WWW::Mechanize keeps an infinitely large stack, which was
leading to OOM errors on my system.

t/check-www-inbox: don't follow mboxes

They can be extremely large with no limit, so can lead to OOM
errors.

t/check-www-inbox: replace IPC::Run with PublicInbox::Spawn

Because WWW::Mechanize uses truckload of memory, fork
needs to prepare all that memory for CoW, which ends up
bailing with ENOMEM.

mid: filter out 'y', 'n', and email addresses from references()

Looking at git@vger history, several emails had broken
References/In-Reply-To pointing to <y>, <n> and email
addresses as Message-IDs in References and In-Reply-To
headers.

This was causing too many unrelated messages to be linked
together in the same thread.

hval: add src_escape for highlight post-processing

We need to post-process "highlight" output to ensure it doesn't
contain odd bytes which cause "wide character" warnings or
require odd glyphs in source form.

viewvcs: wire up syntax-highlighting for blobs

And update 216dark.css to match a color scheme I'm used to;
which is fairly minimal and doesn't use all the classes
"highlight" provides.

hlmod: disable enclosing <pre> tag

We already have a <pre> tag in ViewVCS, and nesting <pre>
inside the pre-existing <pre> overrides the "white-space:pre"
we use to align line numbers.

t/hl_mod: extra check to ensure we escape HTML

Otherwise, it's open season on our users :<

wwwhighlight: read_in_full returns undef on errors

The return value of "print" is not undef for Perl IO::Handle.

solver: crank up max patches to 9999

Might as well, since the only constraint is filesystem space
for temporary files for public-inbox-httpd users.

-httpd can fairly share work across clients with our use of
psgi_qx; and there's a recent patch series in git@vger with 64
patches in sequence.

viewvcs: do not show final error message twice

SolverGit::ERR already writes the exception to the debug
log before calling {user_cb}, so there's no need for viewvcs
to append it.

qspawn: decode $? for user-friendliness

The raw value of $? isn't very useful, generally.

solver: reduce "git apply" invocations

"git apply" is capable of applying multiple patches in one
invocation, so give it multiple patches on the command-line
now that we no longer rely on anonymous file handles to hold
patches.

This cuts down a 64-patch series on git@vger from ~1s to ~800ms
with vfork spawn enabled using Inline::C.

solver: hold patches in temporary directory

We can avoid bumping up RLIMIT_NOFILE too much by storing
patches in a temporary directory.  And we can share this
top-level directory with our temporary git repository.

Since we no longer rely on a working-tree for git, we are free
to rearrange the layout and avoid relying on the ".git"
convention and relying on "git -C" for chdir.

This may also ease porting public-inbox to older systems
where git does not support "-C" for chdir.

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.

extmsg: don't bother partial matching with <16 chars

It's not worth it, and attempts to wildcard off
single-character Message-IDs(*) causes Xapian to error
out in unpredictable ways:

  something terrible happened at /usr/lib/x86_64-linux-gnu/perl5/5.24/Search/Xapian/Enquire.pm line 54.
    ...propagated at lib/PublicInbox/Search.pm line 209.

So don't bother.

(*) because people blindly hit 'y' or 'n' when git-send-email
    prompted them for In-Reply-To.

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).