examples/public-inbox.psgi: add note for our httpd

Default to maximizing compatibility in the example, but document the
potential improvement if possible.  Of course, using
public-inbox-httpd out-of-the-box without a user-specified config
file already enables chunked encoding by default.

http: clarify intent for persistence

We don't actually need to know if a response is chunked or
what the actual Content-Length is; we just need to know if
the PSGI app properly terminated the response so we can
handle persistent connections.

view: link restructuring for index view

The "next/prev" links seem a bit awkward and I don't use them as
much as I expected to.  However, move the "raw" message link
near the top since it's most useful for checking or reinforcing
the validity of the message via GPG or just reading headers.

Turn the Subject line into a permalink to the message, since
that's probably the common behavior anyways for other messaging
systems.  Make the "[threaded|flat]" view links to always
visible for bookmark-ability despite the lack of a "permalink"
label.

http: fix condition for detecting persistence

Oops, we need to watch out for how we handle operator
precedence and ensure responses without a Content-Length
or "Transfer-Encoding: chunked" header will always
disconnect after writing.

www: more explicit "git clone" usage

Little harm in having the entire command-line for users and
avoiding the cognitive overhead of figuring out $URL.

www: various style changes and comment updates

Reduce stack depth of arguments and rely more on state hashref
to store response state.  We may end up shoving everything
in ctx eventually.

httpd: remove reference to callback during close

Avoid wasting memory and the risk of a potential reference
cycles by dropping the callback ASAP.

daemon: expand @ARGV paths for running in '/'

We also require --stdout/--stderr/--pid-file to be absolute
paths for USR2 usage.  However, allow PSGI files for -httpd
to be relative paths for ease-of-use.

feed: fix brain farts in new_oneline removal

Ugh...

Fixes: 476fc666c223 (reduce "PublicInbox::Hval->new_oneline" use)

searchmsg: preserve hard tabs, but drop CR (\r)

Hard tabs *may* be searchable, so preserve them since they do
not take up any more space than a normal space.  However, CR
(carriage return) is worthless and likely a sign of a buggy mail
(or spam) client anyways.

reduce "PublicInbox::Hval->new_oneline" use

It's probably a bad idea to strip extraneous whitespace
from some headers as an extra space may convey useful
information.

Newlines don't seem to be preserved by Email::MIME or
Email::Simple anyways, so there's no danger in breaking
formatting.

http: use Plack::HTTPParser for HTTP parsing

This allows us to reduce installation dependencies while
retaining performance as it favors HTTP::Parser::XS when
it is installed and available.

PLACK_HTTP_PARSER_PP may be set to 1 to force a pure Perl
parser for testing.

examples: disable Chunked response in PSGI example

It seems incompatible with Starman and probably confuses other
HTTP/1.0-only servers, too.  Our -httpd will respect it and
requires it for persistent connections.

http: prevent zero-byte writes

Plack::Middleware::Deflater (and perhaps other middleware)
triggers zero-byte writes which wastes syscalls when
they get passed to Danga::Socket.  This may also trigger
problems when we introduce TLS support in the future.

daemon: fixup usage of the '-l' switch with IP/INET6 sockets

We need to ensure $sock_pkg is preserved outside of the loop.
The variable passed to "for" or "foreach" is implicitly local
and restores the previous value when the loop exits.  This is
documented in the perlsyn manpage in the "Foreach Loops"
section.

Fixes: ea1b6cbd422b ("daemon: allow using IO::Socket::IP over INET6")

daemon: allow using IO::Socket::IP over INET6

IO::Socket::IP is bundled with newer versions of Perl,
so it is more likely to be available.  There should
be no differences between these with our use cases.

http: reject excessively large HTTP request bodies

We cannot risk using all of a users' disk space buffering
gigantic requests.  Use the defaults git gives us since
we primarily host git repositories.

http: ensure errors are printable before PSGI env

We cannot rely on a client socket having a PSGI env before headers
are fully-parsed as we seek to avoid storing hashes for idle
clients.  Sso print errors to the psgi.errors value which belongs to
the httpd listener, instead.

http: reject excessive headers

HTTP::Parser::XS::PP does not reject excessively large
headers like the XS version.  Ensure we reject headers
over 16K since public-inbox should never need such large
request headers.

daemon: sockname detects listeners correctly

This means we can avoid false-positives when inheriting multiple
Unix domain sockets.

daemon: document optional Net::Server dependency

Non-socket activation users will want to install Net::Server
for daemonization, pid file writing, and user/group switching.

doc: add contact/see-also/copyright sections to mda manpage

We need manpages before we can expect people to install this.

httpd: remove unnecessary eval

We have per-middleware evals to deal with them being missing;
no need to put an eval around the whole thing and use an
extra level of indentation.

t/httpd-corner: avoid clobbering existing FDs after fork

Due to the deterministic way reference counting works,
we do not want to drop references to existing FDs
even if we no longer need the glob reference; the actual
FD is all we can pass through on exec.

doc: language-neutral client-side endpoints

Be less specific, client-side code can be written in any
language (and I do not care for JS runtimes implemented in
C++ :P).

doc: varyus speling fickses

Letz trie 2 uphear liter8

feed: remove unnecessary encoding lookup

We handle encoding-related things elsewhere.

daemon: simplify parent death handling

No need to create a new sub which kill ourselves $$ when we can
invoke worker_quit directly.

daemon: avoid cyclic references for once-used callbacks

Not that these subs are repeatedly created, but this makes
the code easier-to-review and these callbacks are idempotent
anyways.

daemon: drop listener sockets ASAP on termination

We do not want to be accepting connections during graceful
shutdown because another new process is likely taking over.
This also allows us to free up the listener case another
(independent) process wants to claim it.

t/httpd-corner: additional callback test

Just to ensure we hit the code path independently of
WWW code.

git-http-backend: favor sysread for regular files

We do not need line buffering, here; so favor sysread to
bypass extra copies which may be done by normal read.

daemon: simplify socket inheriting, slightly

IO::Handle->new_from_fd has existed since at least 1996,
so it should be safe to depend on at this point.

daemon: support listening on Unix domain sockets

Listening on Unix domain sockets can be convenient for running
behind reverse proxies, avoiding port conflicts, limiting access,
or avoiding the overhead (if any) of TCP over loopback.

daemon: introduce host_with_port for identifying sockets

This allows us to share more code between daemons and avoids
having to make additional syscalls for preparing REMOTE_HOST
and REMOTE_PORT in the PSGI env in -httpd.

This will also make supporting HTTP (and NNTP) over Unix sockets
easier in a future commit.

daemon: avoid polluting the main package

We've distilled the daemon code into one public function ("run"),
so avoid polluting the main namespace and just have users
prefix with the full package name for this rarely-used class.

t/*.t: use identifiable tempdir names

This should make identifiying leftover directories
due to SIGKILL-ed tests easier.

view: fix stupid typo in inline_dump

Ugh, this enabled-iff-xapian-is-available code really
needs better testing...

use raw header for Message-ID

Message-IDs should not be MIME encoded, but in case they are,
use the raw form for compatibility with ssoma and possibly
other tools.  This prevents a potential problem where a
malicious client could confuse our storage layer into indexing
incorrect contents.

http: better error handling for EMFILE/ENFILE

Better to throw the error back to the client ASAP if we're
out-of-descriptors.  We will need to implement idle client
expiration for long-lived HTTP connections.

httpd: remove unneeded err and out fields from class

Vestigial pieces from the nntpd code which aren't needed because
the psgi env already has the "psgi.errors" key.

httpd: document pi-httpd.async as totally unstable

We'll have to use it some more before deciding it is a public
interface.  I do hope for it to be a usable public interface
one day for other users.

processpipe: preserve native close behavior

We need to ensure close on handles tied to this class
get the same errors a normal "close" in Perl gets.

linkify: do not capture trailing '.' or ';' in URLs

It seems common for users to end statements with URLs,
while it is rare for a URL itself to end with a '.' or ';'.
So make a guess and assume the URL was intended to not
include the trailing '.' or ';'

extract linkification code to a separate package

This will allow us to more easily reuse it elsewhere.

MANIFEST: add examples/apache2_perl_old.conf

Ugh, I wonder if we can/should generate this automatically...

view: consolidate whitespace stripping from messages

We now keep intermediate blank lines in messages, since it
could be used to denote logical gaps in the message
(such as giving readers a chance to opt out of "spoiler"
information).

However leading blank lines, trailing blank lines, and
trailing whitespace have no useful value we can discern;
so drop those entirely to prevent clients from eating up
vertical whitespace.

view: do not hide patches or signatures

It's often not that much information and may be useful
to reduce HTTP requests a reader will want to make.

fixup Plack-related requires

We do not need to load Plack::Request outside of WWW anymore.

t/init.t: avoid spewing directory names in output

This is a step towards having consistent, reproducible
test output. (ugh, but each %hash usage screws that up).

t/search.t: use transactions to reduce I/O load

In case folks do not use eatmydata or tmpfs for testing,
use transactions to reduce the number of fsync calls
made and hopefully prevent drives from wearing out.

git-http-backend: fixes for mod_perl

Apache2 mod_perl does not give us a real file handle, so
we must translate that before giving that to git-http-backend(1).

Also, parse the Status: correctly for errors since we failed to
set %ENV properly before the previous fix for SpawnPP

spawnpp: use env(1) for mod_perl compatibility

We cannot modify %ENV directly under mod_perl (even after forking!),
so use env(1) instead to pass the environment.

git-http-backend: stricter parsing of CRLF

It is not needed as we know git uses CRLF termination.

favor procedural calls for most private functions

This makes for better compile-time checking and also helps
document which calls are private for HTTP and NNTP.

While we're at it, use IO::Handle::* functions procedurally,
too, since we know we're working with native glob handles.

distinguish error messages intended for users vs developers

For error messages intended to show user error (e.g. giving
invalid options), we add a newline ("\n") at the end to
polluting the output with location information.

However, for diagnosing non-user-triggered errors, we should
show the location of where the error occured.

http: avoid needless time2str calls

Checking the time is nearly free on modern systems with
vDSO/vsyscall/similar while sprintf is always expensive.

http: document event_write usage

It may not be obvious where we are when we enter the event_write
callback.  Hopefully this clarifies things.

http: error check for sysseek on input

Just in case we screwed up somewhere, we need to match up
syswrite to sysseek and we also favor procedural calls for
native types.

examples/public-inbox.psgi: relax license to GPL-3.0+

Using the AGPL for server config files is probably overkill.
GPL-3.0+ still requires appliance vendors to disclose
configurations which seems desirable for end users.

examples: various Apache-related doc updates

Plack::Handler::Apache2 exists and seems to work very well.

examples/cgi-webrick.rb: set CGIPathEnv, update comments

webrick clears PATH otherwise, and we rely on git commands.

examples/: PSGI example updates

Users wanting to customize their installation should know
to about the usability of STDOUT for logging.
(and we still need manpages for -nntpd and -httpd)

spawnpp: die instead of exit on exec failure

Perl may complain about exit not being executed, but not die.

newswww: set Content-Type properly

Oops :x

http: support graceful shutdown like nntp

HTTP responses may be long-running or requests may be slow or
pipelined.  Ensure we don't kill them off prematurely.

reduce calls to close unless error checks are needed

We can rely on timely auto-destruction based on reference
counting; reducing the chance of redundant close(2) calls
which may hit the wront FD.

We do care about certain close calls (e.g. writing to a buffered
IO handle) if we require error-checking for write-integrity.  In
other cases, let things go out-of-scope so it can be freed
automatically after use.

searchidx: use defined for checking EOF behavior

While empty or "0" should never appear, this allows the
reviewer to think and know less about the context in which
this check is done.

t/: remove unnecessary Dumper use

No point in loading Data::Dumper if we do not use it
in the tests.

searchmsg: update + fix license header

Not sure how, but this should've always been AGPL-3.0+ like
the rest of the code, not GPL-3.0+

MANIFEST: update (generate via "git ls-files")

It's been a while...

httpd: allow running if ReverseProxy is missing

Not everybody will be running this behind a ReverseProxy;
but it's probably the likely configuration.  Anyways,
warn about this and also about Deflater being missing.

spawn: disable popen optimization for non-vfork

This is necessary since we want to be able to do arbitrary redirects
via the popen interface.  Oh well, we'll be a little slower for now
for users without vfork.  vfork users will get all the performance
benefits.

spawnpp: fix error message for stderr redirect failing

Oops :x

daemon: refresh before forking

This means we always load the PSGI server code early for
-httpd.  This may make things less compatible with existing
PSGI/Plack apps, but we prioritize our httpd for the uses
of public-inbox itself, first.

And any existing PSGI/Plack app which wants to may adapt
themselves to being preload-friendly.

spawn: fail properly if Inline fails

We must stash the error correctly when nesting evals, oops :x

move executables to script/ directory

This seems to match more closely with what is expected of Perl
packages based on how blib is used.  Hopefully makes the top-level
source tree less cluttered and things easier-to-find.

git: use built-in spawn implementation for vfork

This should reduce overhead of spawning git processes
from our long-running httpd and nntpd servers.

initial spawn implementation using vfork

Under Linux, vfork maintains constant performance as
parent process size increases.  fork needs to prepare pages
for copy-on-write, requiring a linear scan of the address
space.

http: simplify offset calculation slightly

No point in comparing an empty string; length() is only
potentially expensive on big strings.

psgi: enable ReverseProxy middleware by default

ReverseProxy is the common way to run Perl applications,
so enable it by default and don't care too much about fake
requests because we don't handle any sensitive information
or rely on authentication (everything is read-only from
the WWW interface and will remain so).

daemon: update comment about usage in httpd

Writing a read-only IMAP server isn't out-of-scope, either,
but I've never studiied the IMAP protocol, much, unlike HTTP/1.x
or even NNTP.

httpd: avoid loading our WWW-specific code early

We want this to be usable as a generic httpd for other Free Software
projects, so do not force users to load our WWW code at
compile-time.

www: add News* wrappers to preload

We want to preload as much as possible in -httpd when forking
to save memory via CoW.

www: workaround for malformed NNTP links

Some linkifiers to create invalid HTTP links when it sees a
link intended for NNTP services.  This means we may see links
to news.public-inbox.org/inbox.comp.mail.public-inbox.meta
point to "http://" on port 80 instead of 119.  Try to
redirect users to http://public-inbox.org/meta/ in this case.

support protocol-relative URLs in publicinbox.$LISTNAME.url

All URL generation in dynamic HTTP pages should be capable of
generating "https" or "http" URLs depending on the user's
preference.

git-http-backend: extract input_to_file function

This will allow us to more easily read and test later.

extmsg: do not modify shared array via prurl

We cannot modify elements in any shared data strucutures
shared between requests.  Oops!

extmsg: allow returning 404 responses

We will be falling back and cascading to newsgroup lookups, later.

httpd: fill in missing Danga::Socket callbacks

Danga::Socket will die on us if we hit the base implementations.

git-http-backend: avoid multi-arg print statemtents

Even with output buffering disabled via IO::Handle::autoflush,
writes are not atomic unless it is a single argument passed to
"print".  Multiple arguments to "print" will show up as multiple
calls to write(2) instead of a single, atomic writev(2).

git-http-backend: start async API for streaming

git-http-backend may take a while, ensure we can process other
requests while waiting on it.  We currently do this via
Danga::Socket in public-inbox-httpd; but avoid exposing this
internal implementation detail to the PSGI interface and
instead only expose a callback via: $env->{'pi-httpd.async'}

git-http-backend: start refactoring to use callback

Designing for asynchronous, non-blocking operations makes
adapting for synchronous, blocking operation easy.

Going the other way around is not easy, so do it now and
allow us to be more easily adapted for non-blocking use
in the next commit...

use pipe for git-http-backend output

This allows us to stream the output to the client without buffering
everything up-front.  Next, we'll let Danga::Socket (or AE in the
future) wait for readability.

hval: implement common UI for protocol-relative URLs

This allows users to avoid HTTPS -> HTTP downgrade warnings,
but we will also avoid encouraging them towards HTTPS, for now.

IMHO: the CA system gives a false sense of security,
TLS libraries (e.g. OpenSSL) can introduce new bugs and
problems (even to attack clients), and TLS libraries
also eats memory on cheap servers.

www: make interface more OO

This allows multiple instances the WWW app from
running within the same process space

remove direct CGI.pm support

Relying on Plack::Handler::CGI is much easier for long-term
maintenance and development.

Nowadays, we even include our own httpd implementation to
facilitate easier deployment with PSGI/Plack.

www: support $MESSAGE_ID/R/ endpoint for replies

Setting the "In-Reply-To:" header via mailto: links is not
well-supported and should probably not be encouraged unless
the client situation improves.

So instead, teach users more widely-supported ways of setting
the In-Reply-To: header to ensure proper threading of replies.

view: capture header object early

For future changes, this will allow us to more quickly notice
if we keep the heavy Email::MIME object around too long.

It has the side effect of avoiding extra method calls with
Email::MIME which forwards header calls to the header_obj.

t/httpd-corner: test HTTP chunking with curl

Just in case my knowledge of chunking is wrong.