cgit: support running cgit as a standalone CGI

We depend on git-http-backend for smart HTTP clone support,
however; since cgit does not support smart clones natively.
WWW.pm will be able to cascade down to this as a 404 handler in
the future.

spawn: support absolute paths

cgit (and most other CGI executables) is not typically installed
for use via $PATH, so we'll need to support absolute paths to
run it.

githttpbackend: check for other errors and relax CRLF check

Reads to git-http-backend(1) could fail or EOF prematurely,
so we must be ready for that case.

Furthermore, cgit (and possibly other CGI) uses LF instead
of CRLF, so support those programs, too.

githttpbackend: move more psgi.input handling into subroutine

This will be useful for other CGI wrappers we make.
This also fixes a bug with some PSGI servers which did not
present a real IO::Handle in the psgi.input env field.

support publicinbox.cgitrc directive

We can save admins the trouble of declaring [coderepo "..."]
sections in the public-inbox config by parsing the cgitrc
directly.

Macro expansion (e.g. $HTTP_HOST) expansion is not supported,
yet; but may be in the future.

spawn: support RLIMIT_CPU, RLIMIT_DATA and RLIMIT_CORE

We'll be spawning cgit and git-diff, which can take gigantic
amounts of CPU time and/or heap given the right (ermm... wrong)
input.  Limit the damage that large/expensive diffs can cause.

viewvcs: match 8000-byte lookup for git

No need to scan the entire string, but prefer to match git
behavior.  This might be faster if/when Perl can create
substrings efficiently using CoW.

Fix a 80-column violation while we're at it.

viewvcs: preliminary support for showing non-blobs

Eventually, we'll have special displays for various git objects
(commit, tree, tag).  But for now, we'll just use git-show
to spew whatever comes from git.

git: add "commit_title" method

This will be useful for extracting titles/subjects from
commit objects when displaying commits.

githttpbackend: serve $GIT_DIR/info/attributes

This will be useful for reproducibility when mirroring
coderepos and generating diffs.

viewvcs: check for premature EOF from git-cat-file

Not entirely sure what is causing this, but it appears to
be causing infinite loops when attempting to display certain
blobs.

Fortunately, the fair scheduling of public-inbox-httpd prevented
this from becoming a real problem aside from increasing CPU
usage.

config: ignore missing config files

There's no reason for us to have git-config(1) warn users when a
config file is entirely missing.

v2writable: index_sync adds new epochs to alternates

Newly-cloned epochs need to be in alternates file of
all.git for the web and NNTP interfaces to work.  So
allow invocations of "public-inbox-index" to idempotently
ensure the epoch is visible from the all.git repo.

v2writable: hoist out fill_alternates

We'll be using this sub to fill $GIT_DIR/objects/info/alternates
if somebody uses clone --mirror, too

v2writable: fix epoch rollover on incremental imports

All of our internal epoch rollover calculations are done using
the estimated unpacked (and uncompressed) size of the repo.  The
importer instance needs to check that unpacked size before
selecting an epoch when an epoch already has packed data.

This bug did not impact the initial mass imports since we only
initialize the Import instance once-per-epoch and did not need
to take existing epochs into account.

Tested manually with -mda on a local clone of LKML

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

www: prevent '!important' in BOFH-specified CSS

CSS specified by the BOFH must never take precedence over
what a user sets in userContent.css.

usercontent.pm: set "!important" to override BOFH prefs

The sample userContent.css needs a higher priority than what
the BOFH specifies.  In other words, user preference must
ALWAYS take precedence.

Reported-by: Dmitry Alexandrov <321942@gmail.com>
cf. https://public-inbox.org/meta/87mumn4kx8.fsf@gmail.com/

ensure bytes::length is available to callers

We were relying on Danga::Socket using the "bytes" pragma,
previously.  Nowadays, the "bytes" pragma is not recommended in
general, but bytes::length remains acceptable for getting the
byte-size of a scalar.

MANIFEST: add newswww.psgi

Fixes: 285b9b4d7de53b0d ("examples/newswww.psgi: demonstrate standalone NewsWWW usage")

t/perf-msgview.t: fix broken performance test

WwwStream started depending on the WWW::style method
for configurable CSS, so mock ::style so the benchmark
runs properly.

Fixes: f026dbdd392c9dd5 ('www: admin-configurable CSS via "publicinbox.css"')

t/perf-msgview: don't warn about --unordered if skipping

No point in making noise about something that isn't used.

examples/newswww.psgi: demonstrate standalone NewsWWW usage

Plack::Builder allows "mounting" on with hostnames as well as
path names to enable virtual hosting.  This example demonstrates
how port 80/443 for "news.example.com" can redirect browser
requests when somebody attempts to use a "nntp://" URL and
the software assumes "http://"

nntp: get rid of long_response_limit constant

Unused since commit b8c41362f2a5c8fcc6b1846a79c72bfa77565297
("nntp: simplify the long_response API")

http: cleanup partial-write handling on readonly values

Don't bother assigning to $_[1]; just let Danga::Socket
do its thing since $_[1] should be out-of-scope soon.

daemon: favor Socket.pm in Perl 5.14+ for IPv6

Users on Perl 5.14+ are common, so we can try the bundled Socket
(not "Socket6") module before attempting Socket6 for IPv6.

daemon: die properly when Socket6 is missing

We need to keep Unix-socket-only httpd instances working
without Socket6.  This fixes t/httpd-unix.t with Socket6
uninstalled.

Merge remote-tracking branch 'origin/help-color'

* origin/help-color:
  wwwtext: inline sample CSS and use highlight
  hlmod: support "```$LANG" blocks in text
  hlmod: do_hl* performs src_escape immediately
  hlmod: make into a singleton
  hlmod: hoist out do_hl_lang sub
  viewvcs: cleanup utf8 handling

solvergit: include the $oid_want tmpdir name

This can help admins diagnose problems with SolverGit, since
qspawn logs the failed "git apply" command-line in stderr.
(or it can waste admins' time because sometimes there's crap
 mail clients which mangle patches)

TODO: add item for "scraper" importers

The git-users mailing list is on Google Groups with obfuscated
addresses and censored archives.  We should allow users to
import them soon, as obfuscated/censored archives are better
than not having archives at all when Google decides to shut down
yet-another-service.

There's also some mangling that (most) instances of Mailman do
(e.g. cgit), but being able to follow such groups over NNTP
and use our search functionality is still useful and better
than what typical Mailman installations provide.

wwwtext: inline sample CSS and use highlight

For user documentation regarding CSS; showing users the sample
CSS with comments is probably more helpful than having
standalone documentation on CSS classes.

hlmod: support "```$LANG" blocks in text

This is compatible with Markdown; but we still keep the WYSIWYG
nature of plain-text with this.  This is only intended for use
with our documentation.  Enabling any type of Markdown support
for emails can lead to incompatibilities or interopability
problems with alternative implementations.

hlmod: do_hl* performs src_escape immediately

We want to be able to take advantage of this in other modules

hlmod: make into a singleton

It turns out there's no point in having multiple instances of
this or having to worry about destruction or destruction
ordering.

This will make it easier to reuse the one instance we have
across different modules.

hlmod: hoist out do_hl_lang sub

We'll want to use to support highlighting syntax used by
Markdown and possibly other markup languages (while retaining
the raw plain-text layout and formatting).

viewvcs: cleanup utf8 handling

Favor in-place utf8::decode since it's a bit faster without
method dispatch overhead; and don't care about validity just
yet.

HlMod->do_hl itself should return "utf8" strings, since other
parts of our code can use it, so it's not the job of ViewVCS to
post-process HlMod output.

TODO: support migration to v2 without breaking v1 "git fetch"

I'd like to move https://public-inbox.org/git/ to v2; but
cronjobs using "git fetch" to following should not break.

viewdiff: group path match to not be confused by "/dev/null"

Leaving out parentheses caused transitions to state="del" or
state="add" to be misidentified.

cf. https://public-inbox.org/meta/20190204105454.GG10587@szeder.dev/

Reported-by: SZEDER Gábor <szeder.dev@gmail.com>

newswww: add /$MESSAGE_ID global redirector endpoint

This is the fallback for the normal WWW endpoint.

Adding this to the top-level seems to be alright, since lynx and
w3m both understand nntp://<HOSTNAME>/<Message-ID> anyways.

If newsgroup and inbox names conflict, then consider it the
fault of the original sender.

Since NewsWWW is intended to support buggy linkifiers in mail clients,
they can interpret nntp:// URLs as http://<HOSTNAME>/<Message-ID>

Inbox ordering from the config file is preserved since
commit cfa8ff7c256e20f3240aed5f98d155c019788e3b
("config: each_inbox iteration preserves config order"),
so admins can rely on that to configure how scanning
works.

Requested-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
cf. https://public-inbox.org/meta/20190107190719.GE9442@pure.paranoia.local/
    nntp://news.public-inbox.org/20190107190719.GE9442@pure.paranoia.local

viewdiff: support renames and long paths in diffstat anchors

This is best-effort, but works well-enough in practice for
projects which use shell-friendly filenames as well as the
long path names for some Linux kernel selftests.

viewdiff: escape HTML ampersand for renames

For URLs we generate, we need to escape '&' in query parameters
for correctness.

viewvcs: allow '0' as a valid filename for blob downloads

Only to be pedantic...

linkify: support proto://hostname without trailing slash

Sometimes users will write "http://example.com" without the
trailing slash, which every browser and tool I've tested seems
to understand.

view: simplify quote splitting

Perl "split" can capture and group in the regexp itself,
so rely on that to shorten our code.

Comparing the /T/ HTML output of a thread from hell (on LKML with
1356 messages) reveals no difference in the rendered result.
Only the HTML source differs in newline placement before/after
the closing </span>

This allows a minor speedup on my X32 Thinkpad @ 1.6GHz with
the aforementioned LKML thread from hell:

before: 3.67s
 after: 3.55s

view: fix broken hunk header hrefs in Atom feeds

We use absolute URLs in the Atom feeds (to ease
syndication/mirroring), so hunk headers need to point to the
solver URLs.

view: diffstat anchors for multi-message/attachment views

diffstat <-> ^diff anchors work within the same attachment or
message while in HTML views which display multiple messages.

viewdiff: diffstat links to diff anchors

This can be helpful for reviewing larger patches which span
across several files on the permalink (/$MESSAGE_ID/) HTML
page.

More work will be needed to get this working for the /T/ and /t/
pages which show multiple emails, as the filename-based anchors
will conflict at the moment.

hval: routines for attribute escaping

We'll use HTML attributes + anchor links to link to filenames
in coming commits.

Merge remote-tracking branch 'origin/purge'

* origin/purge:
  implement public-inbox-purge tool
  v2writable: read epoch on purge
  v2writable: cleanup processes when done
  v2writable: purge ignores non-existent git epoch directories
  v2writable: ->purge returns undef on no-op
  import: purge: reap fast-export process
  hoist out resolve_repo_dir from -index

doc: remove completed TODO items

doc/config: document "replyto" configuration knob

I hate it, but it's necessary to support some mirrors.

doc/config: user documentation for limiters

I've relied on this feature to keep the VPS behind
https://public-inbox.org/git/ from OOM-ing since 2016,
so document it to ensure others can make use of low-end
servers like I do.

More limiters may become configurable for viewvcs and
solver functionality (or we continue using the default
one).

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.