examples: add empty "lib" dir to placate plackup

This is necessary for Filesys::Notify::Simple 0.13 using
Linux::Inotify2, since 0.13 started croaking on
inotify_add_watch failures.

config: support multi-value inbox.*.*url

Since the beginning of this project, we've implicitly supported
inboxes with multiple URLs by relying on the Host: header sent
by the client ($env->{HTTP_HOST}).

We now offer the option to explicitly configure multiple URLs for
every inbox along with the ability to do a best-effort match for
matching hostnames.

wwwlisting: show configured "infourl" properly

git's config file keys lack underscores, but my mind is wired
for underscores :x.  Fix the whitespace around the info URL
while we're at it, so that it shows up right under the inbox
description.

doc: fix a few spelling errors in user-facing docs

Found by codespell, there's a few more in comments and some
debatable ones, but user-facing stuff is more important.

build: fix xapian-* manpage generation

extman.perl requires the name of its target

doc/txt2pre: flush output before utime()

Otherwise our utime() change is overridden when the flush
happens at exit.

doc: release notes: set Date for 1.2.0, start 1.3.0

Seems like a lot's happened since 1.2, but it's mostly
internal stuff...

build: remove NEWS from dist-git target

mknews doesn't require any optional dependencies a user wouldn't
normally have.  We can save storage and bandwidth costs by
letting cgit serve the exact tar.gz which "git archive | gzip -n"
generates.

doc: allow NEWS file to be built without Plack::Util

Plack pulls in a lot of dependencies which can be time-consuming
to install.  It should not be necessary for somebody who just
wants to run -mda/-watch and -nntpd and forego WWW.

wwwstatic: add directory listing + index.html support

It's now possible to use WwwStatic as a standalone PSGI
app to serve static files and recreate the award-winning
web design of https://public-inbox.org/ :>

wwwstatic: avoid TOCTTOU for FIFO check

We can use Perl's sysopen function to pass O_NONBLOCK to open(2)
and avoid blocking on FIFOs.  This avoids a TOCTTOU race where
somebody can change a regular to FIFO in between the stat(2) and
open(2) syscalls.

wwwstatic: do not open() files for HEAD requests

open() is a much more expensive syscall than stat(),
so avoid it

wwwstatic: move r(...) functions here

Remove redundant "r" functions for generating short error
responses.  These responses will no longer be cached by clients,
which is probably a good thing since most errors ought to be
transient, anyways.  This also fixes error responses for our
cgit wrapper when static files are missing.

www: move more logic into path_info_raw

It'll be easier to reuse in future code.

wwwstatic: implement Last-Modified and If-Modified-Since

We're already serving static files for cgit, and will serve more
static files, soon.

cgit: type declaration for PublicInbox::Git

AFAIK this doesn't do anything for Perl internally since
PublicInbox::Git doesn't "use fields", but it makes it easier for
humans readers to follow and ensure we're not passing unblessed
or non-ref scalars to PublicInbox::GitHTTPBackend::serve.

filter/base: export REJECT as a constant

And update callers to use it, as it makes the code a bit cleaner.
Probably irrelvant, but it should be faster, too, as
"perl -I lib -w -MO=Deparse $FILE" shows REJECT() calls are
constant-folded.

githttpbackend: remove ancient compatibility check

The ref() call could be hitting memory leaks on Perl 5.16.x.

It's been 3 years (2016-12-25) since 292ca34140489da2
("githttpbackend: simplify compatibility code") back when
this project was barely known and probably nobody used
examples/public-inbox.psgi...

http: update comment about psgix.io usage

We've been using async_pass for a while.

wwwstatic: getline: die on missing psgix.io

"psgix." extensions aren't guaranteed, so make we should
try and support some theoretical generic PSGI servers
without "psgix.io" on errors by die-ing.

While we're at it, make the error handling path more obvious by
sharing more code between the EOF and errno ($!) cases.

spamcheck/spamc: pass GLOB handles instead of FD numbers

The spawn() interface improvements[1] propagate to popen_rd,
too, so we can avoid weird dances to keep the GLOB handle
references live and just pass the handle around.

[1] commit 267371b1273b518215939e817e53733584b68af7
    ("spawn: allow passing GLOB handles for redirects")

nntp: handle 2-digit year "70" properly

Time::Local has the concept of a "rolling century" which is
defined at 50 years on either side of the current year.  Since
it's now 2020 and >50 years since the Unix epoch, the year "70"
gets interpreted by Time::Local as 2070-01-01 instead of
1970-01-01.

Since NNTP servers are unlikely to store messages from the
future, we'll feed 4-digit year to Time::Local::{timegm,timelocal}
and hopefully not have to worry about things until Y10K.

This fixes test failures on t/v2writable.t and t/nntpd.t since
2020-01-01.

spawn: better error handling

Since vfork always shares memory between the child and parent,
we can propagate errors to the parent errno using shared memory
instead of just dumping to stderr and hoping somebody sees it.

spawn: support chdir via -C option

This simplifies our admin module a bit and allows solver to be
used with v1 inboxes using git versions prior to v1.8.5 (but
still >= git v1.8.0).

spawn: allow passing GLOB handles for redirects

We can save callers the trouble of {-hold} and {-dev_null}
refs as well as the trouble of calling fileno().

search: load_xapian: return true on success

This was causing -xcpdb and other admin modules to fail
outside of tests (or when testing with the slow TEST_RUN_MODE=0).

Merge branch 'no-closure'

* no-closure: (30 commits)
  search: retry_reopen passes user arg to callback
  solvergit: allow passing arg to user-supplied callback
  viewvcs: avoid anonymous sub for HTML response
  wwwattach: avoid anonymous sub for msg_iter
  view: msg_iter calls add_body_text directly
  searchview: remove anonymous sub when sorting threads by relevance
  view: thread_html: pass named sub to WwwStream
  searchview: pass named subs to Www*Stream
  wwwtext: avoid anonymous sub in response
  contentid: no anonymous sub
  view: msg_html: stop using an anonymous sub
  view: avoid anon sub in stream_thread
  config: each_inbox: pass user arg to callback
  feed: avoid anonymous subs
  mboxgz: pass $ctx to callback to avoid anon subs
  www: lazy load Plack::Util
  githttpbackend: split out wwwstatic
  qspawn: psgi_return: allow non-anon parse_hdr callback
  qspawn: drop "qspawn.filter" support, for now
  qspawn: psgi_qx: eliminate anonymous subs
  ...

ds: use MSG_MORE when wbuf is empty during long responses

HTTP::getline_pull and NNTP::long_step will both populate {wbuf}
manually to avoid recursion, so we need to account for an
empty-but-present {wbuf} while dispatching msg_more().

search: retry_reopen passes user arg to callback

This allows callers to pass named (not anonymous) subs.

Update all retry_reopen callers to use this feature, and
fix some places where we failed to use retry_reopen :x

solvergit: allow passing arg to user-supplied callback

This allows us to get rid of the requirement to capture
on-stack variables with an anonymous sub, as illustrated
with the update to viewvcs to take advantage of this.

v2: fix error handling for missing OIDs

viewvcs: avoid anonymous sub for HTML response

No need to create a new sub for every HTML page we render
with our VCS viewer.

wwwattach: avoid anonymous sub for msg_iter

We can pass arguments to msg_iter for msg_iter to pass
to our user-supplied callback, now.

view: msg_iter calls add_body_text directly

No need to waste several kilobytes creating an anonymous sub for
every invocation of msg_iter.

searchview: remove anonymous sub when sorting threads by relevance

We don't need to return a closure or have a separate hash
for sorting threads by relevance.  Instead, we can stuff
the relevance {pct} into the SearchMsg object itself and
use that.

Note: upon reviewing this code, the sort-by-relevance seems
bogus as it only considers the relevance of the topmost message.
Instead, it would make more sense to the user to sort by the
highest relevance of all messages in that particular thread.

view: thread_html: pass named sub to WwwStream

We can pass everything we need into the WWW $ctx to avoid
allocating kilobytes of memory for an anonymous sub for every
$MESSAGE_ID/t/ request.

searchview: pass named subs to Www*Stream

Both WwwStream and WwwAtomStream ->response pass the WWW $ctx
to the callback nowadays, so we can pass named subs to them.

wwwtext: avoid anonymous sub in response

We can pass arbitrary local variables via WWW $ctx, so
just pass that into the one-off _do_linkify sub which
already exists.

contentid: no anonymous sub

msg_iter now passes a user specified arg into the supplied
callback, so we can use that to pass the Digest object into
the \&content_dig_i callback.

view: msg_html: stop using an anonymous sub

Stash 5 local variables into the WWW $ctx hash table instead of
allocating several kilobytes for an anonymous sub.

view: avoid anon sub in stream_thread

WwwStream already passes the WWW $ctx to the callback sub, so we
don't need to create a new sub every call to capture local variables
for the callback.

config: each_inbox: pass user arg to callback

Another place where we can replace anonymous subs with named
subs by passing a user-supplied arg.

feed: avoid anonymous subs

WwwStream already passes the WWW $ctx to the user-supplied
callback, and it's a trivial change for WwwAtomStream to do
the same.  Callers in Feed.pm can now take advantage of that
to save a few kilobytes of memory on every response.

mboxgz: pass $ctx to callback to avoid anon subs

Another place where we can rid ourselves of most anonymous subs
by passing the $ctx arg to the callback.

www: lazy load Plack::Util

cgit users won't need Plack::Util, here.

githttpbackend: split out wwwstatic

Make it easier to share code between our GitHTTPBackend and Cgit
packages, for now, and possibly other packages in the future.

We can avoid inline_object and anonymous subs at the same
time, reducing per-request memory overhead.

qspawn: psgi_return: allow non-anon parse_hdr callback

Callers can supply an arg to parse_hdr, now, eliminating the
need for closures to capture local variables.

qspawn: drop "qspawn.filter" support, for now

This feature was added in preparation for future changes
that have yet to materialize after nearly 3 years.  We
can re-add it if needed in the future.

qspawn: psgi_qx: eliminate anonymous subs

We can follow what we did in psgi_return to make psgi_qx
allocate less memory on each call.

qspawn: psgi_return_start: hoist out from psgi_return

Instead of just passing the rpipe to the start_cb, pass the
entire qspawn ref to start_cb.  Update existing callers to
avoid circular refs.

qspawn: psgi_return: initial cb can be named

We can take advantage of HTTPD::Async being able to pass
user-supplied args to callbacks to get rid of one (of many)
anonymous subs in the code path.

httpd/async: get rid of ephemeral main_cb

Cheaper to use up two hash table slots than creating a new sub.

qspawn: reduce local vars, de-anonymize rd_hdr

rd_hdr() now becomes a named subroutine instead of a per-call
local variable, so kilobytes of memory will not have to be
allocated for it on every ->psgi_return call.

msg_iter: provide means to stop using anonymous subs

And remove the last anonymous sub in SolverGit itself.

qspawn: replace anonymous $end callbacks w/ event_step

This will tie into the DS event loop if that's used, but
event_step an be called directly without relying on the
event loop from Apache or other HTTP servers (or PSGI tests).

qspawn: disambiguate command vs PSGI env

Make things easier-to-follow and paves the way for future work
to reduce dependencies on anonymous subs capturing local variables.

qspawn: remove some anonymous subs for psgi_qx

By passing a user-supplied arg to $qx_cb, we can eliminate the
callers' need to capture on-stack variables with a closure.
This saves several kilobytes of memory allocation at the expense
of some extra hash table lookups in user-supplied callbacks.  It
also reduces the risk of memory leaks by eliminating a common
source of circular references.

httpd/async: support passing arg to callbacks

Another step towards removing anonymous subs to eliminate
a possible source of memory leaks and high memory use.

git: allow async_cat to pass arg to callback

This allows callers to avoid allocating several KB for for every
call to ->async_cat.

wwwlisting: do not rely on $? after ProcessPipe::CLOSE

ProcessPipe::CLOSE won't reliably set $? inside the event loop
if waitpid(..., WNOHANG) isn't successful.  So use a blocking
waitpid() call, here, and hope "git show-ref" exits promptly
since we've already drained its stdout.

t/solver_git: test with -httpd, too

Solver uses the internal -httpd async API if available for
fairness when applying large patchsets.  We must test those
code paths in addition to the generic PSGI code paths.

t/www_listing: test "all" HTML listing

We now have coverage for PublicInbox::WwwListing::list_all.

t/www_listing: quiet down stderr in -httpd

We need to init all.git for the v2 repo test to ensure
`git --git-dir=v2/all.git rev-parse --git-path objects/info/alternates`
doesn't warn or fail and clutter stderr.  This is noticeable
when setting TAIL="tail -F" in env before running this test.

t/psgi_v2: test search results Atom feed endpoint

The "x=A" search results endpoint finally gets test coverage.

t/search.t: update permissions check for OpenBSD

OpenBSD (tested 6.5 on amd64) seems to follow the same semantics
as FreeBSD for S_ISGID, even if config.mak.uname in git.git
doesn't say so.

search: support SWIG-generated Xapian.pm

Xapian upstream is slowly phasing out the XS-based Search::Xapian
in favor of the SWIG-generated "Xapian" package.  While Debian and
both FreeBSD have Search::Xapian, OpenBSD only includes the "Xapian"
binding.

More information about the status of the "Xapian" Perl module here:
https://trac.xapian.org/ticket/523

searchidx: call "++" on PostingIterator instead of "->inc"

The "++" is not yet available in the SWIG-based "Xapian.pm" Perl
bindings, so use "++" where it's supported in both the XS
(Search::Xapian) and SWIG-based Xapian binding.

testcommon: add require_mods method and use it

This cuts down on lines of code in individual test cases and
fixes some misnamed error messages by using "$0" consistently.

This will also provide us with a method of swapping out
dependencies which provide equivalent functionality (e.g
"Xapian" SWIG can replace "Search::Xapian" XS bindings).

remove "no warnings 'once'" in a few places

We can use "use" to get the namespace into the "BEGIN" phase of
the interpreter.  While we're at it, use \&coderef syntax
explicitly instead of globbing everything.

nntp: cmd_xover: use named sub for long_response

Introduce xover_i, which does the same thing as the anonymous
sub it replaces.

nntp: hdr_msg_id: use named sub for long_response

Introduce hdr_msgid_range_i, which does the same thing as the
anonymous sub it replaces.

nntp: cmd_newnews: use named sub for long_response

Introduce newnews_i, which does the same thing as the anonymous
sub it replaces.

nntp: cmd_listgroup: use named subs for long_response

Introduce listgroup_range_i and listgroup_all_i subs which
do the same things as the anonymous subs they replace.

nntp: cmd_xrover: use named sub for long_response

Introduce xrover_i which does the same thing as the anonymous
sub it replaces.

nntp: hdr_searchmsg: use named sub for numeric range response

Introduce searchmsg_range_i, which does the same thing as
the anonymous sub it replaces.

nntp: remove cyclic refs from long_response

Leftover cyclic references are a source of memory leaks.  While
our code is AFAIK unaffected by such leaks at the moment,
eliminating a potential source of bugs will make maintenance
easier.

We make the long_response API cycle-free by stashing the
callback into the NNTP object.  However, callers will need
to be updated to get rid of the circular reference to $self.
We do that be replacing anonymous subs with name subroutine
references, such as xref_range_i replacing the formerly
anonymous sub inside hdr_xref.

nntp: get_range: return scalarref for $beg

...Instead of just returning a plain scalar inside an arrayref.

This is because we usually pass the result of NNTP::get_range to
Msgmap::msg_range.  Upcoming changes will move us away from
anonymous subroutines, so this change will make followup commits
easier-to-digest as modifications to the underlying scalar can
be more easily propagated between non-anonymous-subs.

http: avoid anonymous sub for getline callback

We can avoid the danger of self-referential subs entirely for
code internal to PublicInbox::HTTP.

This change was only made possible by
commit 8e1c3155da4edc082e8e3d8b30351f0c861757a7
("ds: pass $self to code references")

http: get rid of anonymous subs for write/close

Each sub costs us several kilobytes of memory for every
response we make.  An arrayref only costs 80 bytes on
64-bit, so bless that to packages with appropriate ->write
and ->close methods.

nntp: get rid of some unused imports

Our NNTP code no longer relies on search or Xapian.  Msgmap
and Git modules are loaded anyways through Inbox->(git|mm|over)
methods, however.

nntp: simplify method detection using UNIVERSAL::can

No need to do an eval dance or disable strict refs.

testcommon: require_git: use "plan" from Test::More

require_git is no longer in the "::main" namespace, so we must
call Test::More::plan() explicitly.

searchview: save a column in &x=t thread skeleton

Displaying "100%" wastes a precious column.  Show "99%" instead
since there's little practical difference and <xapian/mset.h>
states:

  Note that these generally aren't percentages of anything meaningful
  (unless you use a custom weighting formula where they are!)

And we're not using a custom weighting formula.

view: show percentage in search results thread skeleton

The displays the Xapian ->get_percent value in the skeleton to
improve scanning of relevancy; irrelevant results do not display
that.

This fixes broken #anchor links introduced in the previous
commit, irrelevant messages now link to the /$INBOX/$MESSAGE_ID page.

searchthread: fix usage of user-supplied parameter

Instead of only passing an Inbox object, we'll pass the $ctx
reference as PublicInbox::SearchView::mset_thread did.

So although mset_thread was wrong, we now make it's usage
of SearchThread::thread correct and update other callers to
favor the new style of passing the entire $ctx (with ->{-inbox})
instead of just the Inbox object.

This makes the thread skeleton at the bottom of the search
page to show subjects of messages, but unfortunately links to
non-existent #anchors.  The next commit will fix that.

While we're at it, favor "\&foo" over "*foo" since the former
makes the code reference (aka "function pointer) obvious so it
won't be confused for other things named "foo" in that
scope (e.g. $foo/@foo/%foo).

testcommon: fix run_script for older Perls

Using Perl "open" to dup(2) and save the old handles is required
since "local *STDIN = *STDIN" does not work on old Perls.  Even
worse, this was silently a no-op when tested with Perl 5.24.1 on
Debian 9.x and led to confusing failures in the t/httpd-corner.t
lsof(1) tests when run after t/v2mirror.t from the same worker
process using t/run.perl.

t/run.perl: to avoid repeated process spawning for *.t

Spawning a new Perl interpreter for every test case
means Perl has to reparse and recompile every single file
it needs, costing us performance and development time.

Now that we've modified our code to avoid global state,
we can preload everything we need.

The new "check-run" test target is now 20-30% faster
than the original "check" target.

tests: move t/common.perl to PublicInbox::TestCommon

We want to be able to use run_script with *.t files, so
t/common.perl putting subs into the top-level "main" namespace
won't work.  Instead, make it a module which uses Exporter
like other libraries.

t/*.t: avoid sharing "my" variables in subs

These usages of file-local global variables make the *.t files
incompatible with run_script().  Instead, use anonymous subs,
"our", or pass the parameter as appropriate.

msgiter: msg_part_text returns undef on text/html

We want HTML parts to be downloadable, but not displayed as
unreadable (but injection-safe) HTML source in our own web
and Atom interfaces.

This affects indexing, too, as HTML tags/comments won't be
indexed anymore, but existing indices are only cleaned after
--reindex.  HTML-only mail won't be indexed at all, but we won't
cross that bridge until somebody cares about that crap.   We'll
continue to actively discourage such waste of CPU cycles,
bandwidth, cache and storage.

Fixes: 7d82a8bc04ce2e68 (handle "multipart/mixed" messages which are not multipart')

Makefile.PL: sort target and var lists

Sorting makes it easier to review the generated result.

viewvcs: flesh out some functionality and test

Expose MAX_SIZE via "our" will make it possible
to use in tests, and configure, later.

Additionally, returning HTTP 500 code for big files is not an
Internal Server Error, just a memory limit...  Some browsers
won't show our HTML response with the link to the raw file in
case of errors, either, so we'll return 200 to ensure users can
use the link to access the raw blob.

Finally, throw in some tests to the existing solver_git testcase,
since that was incomplete and was pointlessly loading Plack
modules without testing PSGI.

TODO: add UUCP address item

We should support historical archives from the old days,
but I'm not sure how to best go about it, for now, given
how tricky correct handling of modern email addresses is.
We can deal with it if/when somebody decides to import some
ancient archives...

Makefile.PL: allow overriding "prove" from make CLI

Development versions of Perl install "prove$VERSION"
where $VERSION is something like "5.31.7".  This makes
it easier to test everything we have against development
versions of Perl5.

Note: I could not find a way to get quoting right to use the
"--exec $(PERL)" option of prove(1), but that would be the best
option for working transparently after running:

perl5.31.7 Makefile.PL

t/edit.t: drop redundant "delete local $ENV{...}"

"delete local" is only in Perl v5.11.0, and we only depend on
Perl v5.10.1.  We already localize and delete it as two separate
statements immediately above.

I wish this was hidden behind a "use feature" flag like other
new-fangled things :<.  Oh well, I think the oldest Perl actually
in use for this project is 5.16 (CentOS 7.x).

daemon: drop listeners early in master on graceful shutdown

For users not relying on socket activation via systemd (or
similar), we want to drop listeners ASAP so another process
can bind to their address.  While we're at it, disable
TTIN and HUP handlers since we have no chance of starting
usable workers without listeners.

daemon: shorten lifetime of listener_names mapping

Keeping a ref to the IO::Socket handle was preventing
close(2) from being invoked on graceful shutdown of
worker.

address: explicitly reject local-only addresses

Apparently, neither our previous address parsing code nor
Email::Address::XS recognizes local, username-only addresses
in the form of <username> (without "@host").  Without
this change, Email::Address::XS->address would return
"undef", so we need to filter it out via "grep { defined }"

It seems the cases where users email each other on the same
machine is small and public-inbox won't be able to index
addresses for those cases...  Oh well :/

address: use Email::Address::XS if available

Email::Address::XS is a dependency of modern versions of Email::MIME,
so it's likely loaded and installed on newer systems, already;
and capable of handling more corner-cases than our pure-Perl
fallback.

We still fallback to the imperfect-but-good-enough-in-practice
pure-Perl code while avoiding the non-XS Email::Address (which
was susceptible to DoS attacks (CVE-2015-7686)).  We just need
to keep "git fast-import" happy.

address: use comment as name if no phrase available

Some users will set their From: headers in the form of:
"<user@example.com> (A U Thor)", where their name is in
the parenthesized comment.  Use that instead of the
email address, if available.

inbox: fix periodic git process cleanup

We need to use $PublicInbox::DS::in_loop instead of ::running().
The latter is not valid for systems with signalfd or kqueue and
is now gone, completely.

Not needing periodic cleanups at all to deal with unlinked pack
indices will be a tougher task...