*idx: pass $smsg in more places instead of many args

We can pass blessed PublicInbox::Smsg objects to internal
indexing APIs instead of having long parameter lists in some
places.  The end goal is to avoid parsing redundant information
each step of the way and hopefully make things more
understandable.

overidx: parse_references: less error-prone args

Favor `$smsg->{mid}' instead of `$mid0' to reduce parameters
down-the-line, but favor passing the Email::MIME::Header object
around instead of relying on the bloat-prone `$smsg->{mime}'
and calling ->header_obj on it.

smsg: to_doc_data: use existing fields

No need to pass extra parameters to this method, since
smsg has universal meanings for {blob} and {mid}.

rename PublicInbox::SearchMsg => PublicInbox::Smsg

Since the introduction of over.sqlite3, SearchMsg is not tied to
our search functionality in any way, so stop confusing ourselves
and future hackers by just calling it "PublicInbox::Smsg".

Add a missing "use" in ExtMsg while we're at it.

v2writable: preserve timestamps from import

While v2 indexing is triggered immediately after writing the
commit to the git repository, there may be a gap between when
PublicInbox::Import generates a timestamp and when
PublicInbox::SearchIdx sees the message.  So follow the mirror
indexing behavior and take the to-be-indexed (time|date)stamps
directly from the git commit.

index: use git commit times on missing Date/Received

When indexing messages without Date: and/or Received: headers,
fall back to using timestamps originally recorded by git in the
commit object.  This allows git mirrors to preserve the import
datestamp and timestamp of a message according to what was fed
into git, instead of blindly falling back to the current time.

t/msgtime: skip test if timezone isn't UTC

Date::Parse falls back to using the local timezone when
it's missing from an email, so only test in a reasonable
TZ (UTC) for server software.

t/www_listing: avoid 'once' warnings

We reach into the WwwListing package directly to retrieve
that JSON encoder/decoder object, and we can't rely on `use'
since WwwListing loading may fail if Plack is missing.

wwwlisting: use first successfully loaded JSON module

And not the last...

I only noticed this since JSON::PP::Boolean was spewing
redefinition warnings via overload.pm

Fixes: 8fb8fc52420ef669 ("wwwlisting: avoid lazy loading JSON module")

examples/*.psgi: add examples for -httpd

public-inbox-httpd should work with any PSGI files, so make
it more apparent to people reading .psgi examples.

viewdiff: favor `qr' to precompile regexps

We can also avoid `o' regexp modifier, since it isn't
recommended by Perl upstream, anymore (although we don't
have any bugs or unintended behavior because of it).

daemon: do more immortal allocations up front

Doing immortal allocations late can cause those allocations
to end up in places where it fragments the heap.  So do more
things up front for long-lived daemons.

www: avoid `state' usage to perform allocations up-front

We want WWW->preload to get as many immortal allocations done
as possible, and the `state' feature from Perl 5.10 prevents that.

wwwlisting: avoid lazy loading JSON module

We already lazy-load WwwListing for the CGI script, and
hiding another layer of lazy-loading makes things difficult
to do WWW->preload.

We want long-lived processes to do all long-lived allocations up
front to avoid fragmentation in the allocator, but we'll still
support short-lived processes by lazy-loading individual modules
in the PublicInbox::* namespace.

Mixing up allocation lifetimes (e.g. doing immortal allocations
while a large amount of space is taken by short-lived objects)
will cause fragmentation in any allocator which favors large
contiguous regions for performance reasons.  This includes any
malloc implementation which relies on sbrk() for the primary
heap, including glibc malloc.

wwwlisting: favor "use" over require

"use" is also evaluated earlier than "require", so it is
favorable for compile-only checking.

www: update ->preload for newer modules

We'll also avoid explicitly loading standard library modules
like POSIX and Digest::SHA, here; instead we load our own
modules and let those load whatever non-PublicInbox:: modules
they need.

doc: standards: add references to RFC 5322 (and RFC 822)

RFC 5322 is the latest one in this line, but much documentation
and even command-line options in other programs (e.g. git) refer
to RFC 2822 or even RFC 822.

http: fix RFC conformance w.r.t. message length

We need to favor "Transfer-Encoding: chunked" over the value of
the Content-Length header.  We should also reject bogus,
duplicate and/or unreasonable values for both these, since they
can trigger unexpected behavior when combined with other HTTP
parsers in proxies such as varnish, nginx, haproxy, etc...

See RFC 7230 (and RFC 2616) for more details:

https://tools.ietf.org/html/rfc7230
https://www.rfc-editor.org/errata_search.php?rfc=7230

INSTALL: refer to the proper Debian version

Debian 10.0 was released July 2019, so update our documentation
to reflect that.  While we're at it, fixup a broken footnote
reference for Inline::C, too.

daemon: remove unused $parent_pipe variable

We can just create a ParentPipe and let PublicInbox::DS
manage its life cycle.  While we're at it, favor `\&coderef'
over `*coderef' so we're explicit about it being a code ref
and not some other ref type.

searchmsg: allow lines (and bytes) to be zero

We will occasionally see legit messages with zero lines,
be sure we index that count for NNTP clients.

I'm not sure about bytes being zero (aside from purged
messages), but we should've dealt with that earlier up
the stack.

git: remove POSIX::dup2 import

We rely on spawn/popen_rd for redirects, nowadays.

spawn: correctly handle error code

Both the C and pure Perl implementions of `pi_fork_exec'
returns `-1' on error, not `undef'.

msgtime: assume +0000 if TZ missing when using Date::Parse

Some old emails don't have timezone offsets, since our
Date::Parse code path takes a liberal interpretation of dates,
fallback to using "+0000" as the timezone offset since it's
closer to the actual date of the message than whatever the
current date is.

Reported-by: Leah Neukirchen <leah@vuxu.org>
Link: https://public-inbox.org/meta/87h7zfemur.fsf@vuxu.org/
Fixes: ae80a3fdb53d7014 ("MsgTime.pm: Use strptime to compute the time zone")

import: drop '<' and '>' characters in addresses

Some strange "From:" lines will cause Email::Address::XS to
leave '<' (and presumably '>') in the address which
git-fast-import won't accept even if quoted.  Workaround this
problem by deleting '<' and '>' the same way we delete them for
the ident name.

Reported-by: Leah Neukirchen <leah@vuxu.org>
Link: https://public-inbox.org/meta/87h7zfemur.fsf@vuxu.org/

INSTALL: update for 1.3.0+, clarify IO::Compress

IO::Compress is required for v2 inboxes and overview
indices, after all, but it is often pulled in by
other packages (HTTP::Message via Plack::Test).

doc: design_www: document offline friendliness

This isn't anything new and has been a part of the design
since the beginning, but it may not be apparent to some
folks.

searchview: improve naming and simplify hash override

`%over' could be confused for the overview SQLite DB
instance, so call it `%override', instead.  There's
also no need to write a loop to override a hash when
the language can do it for us.

doc: 1.4.0 release notes update

Perhaps 1.4.0 will be a small release, after all (and also
smaller in terms of memory use :)

v2writable: lookup_content => content_exists

It only needs to return a boolean, since none of the current
callers care about the return value.  Thus avoid a hash table
assignment and use of `$smsg->{mime}', here.

v2writable: make remove return-compatible w/ Import::remove

Import::remove is a documented interface, and the return
value of the V2Writable work-alike should try to be compatible
with what Import implements.

examples/nginx_proxy: convert CRLF to LF

It was the only file in our tree which had CRLF line endings,
so make it consistent with the rest.

viewdiff: remove optional CR handling

The only caller of `flush_diff' is `add_text_body', and that
already did CRLF conversion on the text part.  The regexps in
SolverGit still need to preserve CR, however, since that
actually applies patches (instead of rendering them), and we
need to preserve CRLF patches for CRLF files.

hval: ascii_html: drop CRLF => LF conversion

Instead, we add CRLF conversion to the only remaining place
which needs it, ViewVCS.  This save many redundant ops in in
many places.

The only other place where this mattered was in
View::add_text_body, but we already started doing CRLF
conversions when we added diff parsing and link generation for
ViewVCS.  Otherwise, all other places we used this was for
header viewing and Email::MIME doesn't preserve CRLF in headers.

import_vger_from_mbox: add --filter parameter

It shouldn't be hard to make this into a more generic
importer not specific to vger lists.

import_vger_from_mbox: drop redundant "use" statements

PublicInbox::InboxWritable takes care of those imports.

searchview: set obfuscation inbox properly

We never lookup `$ctx->{-obfuscate}' anywhere, as the
correct key is `$ctx->{-obfs_ibx}' since some of the
address obfuscation stuff is inbox-specific.

Note: some of the obfuscation stuff still needs tests,
but it's low-priority at the moment since I don't think
it's a good feature after all.

doc: technical: document data structures

Can't code without data structures, and we emphasize
data over code just about everywhere.

INSTALL: s/repositories/inboxes/

Since v2 inboxes can be made of several git repositories,
consistently call them "inboxes", instead.

doc: improve wording of "inbox" vs "repository"

Since v2 inboxes contain multiple git repositories, avoid the
use of the word "repository" when referring to inboxes as a
whole in most places.

view: shorten life of MIME object for permalink

We don't need to hold onto the Email::MIME object across
multiple WwwResponse->getline calls, instead we can stuff
the rendered HTML of the first (and hopefully only) message
of the buffer into ctx->{-html_tip}.

doc: design_www: document solver endpoint

The blob regeneration (solving) part has been stable and
performant for over a year with no problems, even with web
crawlers constantly hitting it without needing rate limits.

All the other stuff is open to bikeshedding (as long as
my crappy hardware supports it :P)

viewdiff: do not generate "a=" parameter if "b=" matches

Long URLs waste bandwidth and redundant query parameters
make caching more difficult and expensive.

Fixes: ddec19694cbf0e1d ("viewdiff: rewrite and simplify")

view: remove last Hval->new caller

The object-oriented Hval API turned out to be less useful and
more clunky than I envisioned years ago, so get rid of it.
We'll no longer strip trailing whitespace from From: headers in
the HTML display, but I doubt anybody cares.

view: escape ampersand in Message-IDs

We need to escape ampersands (and some other characters for href
attributes), so introduce a `mid_href' sub to do just that.

'<', '>' and '"'  were always escaped, so there's no risk of tag
or attribute injection, but creative Message-IDs could cause
confusion for some parsers and generate invalid URLs.

Start getting rid of the bloated, over-engineered OO Hval API
while we're at it, I only noticed this bug because I started
killing off Hval->new* callers.

view: escape Subject HTML directly

No need to use the over-engineered Hval OO API when the subject
is already normalized and there's no trailing spaces because of
normalization.

view,searchview: avoid smsg method calls when using SQLite/Xapian

We already pre-populate the hashref when loading $smsg
(PublicInbox::SearchMsg) objects out of over.sqlite3 or Xapian,
so making expensive method calls isn't necessary in those cases.

We only need to use the method calls when SQLite or Xapian are
not available or are being populated (such as during indexing).

view: cleanup topic accumulation and dumping

Avoid needlessly normalizing the subject when dumping, since
it's pushed into the @$topic array during accumulation in
normalized form.

We can also safely treat $smsg as a hashref and avoid
calling "->ds" as a method since we know we've got that
loaded via Over||Search and won't have to use Email::MIME
header lookup methods.

view: dump_topics: better naming of top Subject

We use `$top' in other places, so name it to `$top_subj'
consistently for `$subj' and `$prev_subj' comparisons down
the function.

view: single id="t" for multi-Subject messages

While multi-Subject messages are unfortunate, try not to
generate confusing/invalid HTML with multiple elements
having the same HTML id attribute.

view: remove mhref arg from multipart_text_as_html

No point in passing something on stack only to stash it
into the $ctx which holds most other parameters used for
rendering the HTML.

t/msg_iter: test for X-UNKNOWN charset from Alpine

A long overdue test for behavior established in 2016.

Fixes: 1b28cc7f00a866cb ("view: try assuming UTF-8 for bogus charsets")

doc: update v1.3.0.eml with actual headers, start v1.4.0

Bigger changes coming :>

public-inbox 1.3.0

t/multi-mid: skip properly w/o DBD::SQLite

SearchIdx always requires DBD::SQLite, so only require it
after we've passed `require_mods(qw(DBD::SQLite))'.

convert: preserve indexlevel on conversions

We don't want to blow up users storage too badly when converting
v1 to v2 or break because they don't have Xapian bindings installed.

doc: more 1.3.0 release notes updates

doc: mark some TODO items as done

NNTP TLS and COMPRESS support and cgit spawning from
the WWW interface were implemented last year.

Given the lack of syscall number stability guarantee on the
OpenBSD and FreeBSD, I don't think supporting a pure-Perl kevent
is feasible.  Inline::C may still be an option since IO::KQueue
is abandoned, though, as it is for some Linux-only syscalls and
maybe some POSIX ones not covered by POSIX.pm.

doc: update copyright for standards.perl

It was missing "(C)", so gnulib update-copyright missed it.

tests: switch to XML::TreePP for testing Atom feeds

XML::Feed pulls in a lot of dependencies, some of which XS.
That makes testing with blead or any non-OS-supplied Perl
installations more time consuming and more difficult because
of the need to have development headers and libraries for
libexpat1 or libxml2.

Performance from libexpat1 or libxml2 for our small tests cases
isn't relevant, either, and the pure Perl XML::TreePP seems up
to the task.  It's also available in CentOS 7.x, FreeBSD 11.x,
and Debian, at least.

syscall: support Linux x32 ABI

The x32 ABI allows users to take advantage of the extra
registers on x86-64 without the bloat of 64-bit pointers and
longs.

This ought to be significant since Perl was designed when 32-bit
was prevalent; and the common structs for ops, hashes, scalars,
and arrays use longs (SSize_t/Size_t) for things which should
never need 64-bits when processing emails.

Debian's x32 port seems to work quite nicely under a chroot
on an amd64 Linux system.  All tests pass under x32, now.

treewide: run update-copyrights from gnulib for 2019

I didn't wait until September to do it, this year!

MANIFEST: add flow.{ge,txt}

Oops :x

doc: v1: add a reference to git-filter-repo(1), too

The git-filter-branch(1) manpage itself recommends git-filter-repo,
nowadays due to performance and safety problems.

doc: txt2pre: auto-linkify manpage references

This can be more convenient for people browsing HTML docs
remotely or locally.

doc: remove .x/ subdirectory for Xapian manpages

There's no need to keep Xapian manpage renderings in a separate
subdirectory, after all.

Eliminating this difference between the local FS and URL path
will allow relative URLs to the Xapian manpages in our local
HTML documentation to work smoothly, since there was never any
".x/" path component for files served from public-inbox.org

doc: add data flow diagram using Graph::Easy

Maybe this can make it easier for new and potential
users to understand what's going on.

t/multi-mid: don't access ~/.public-inbox/config

It can cause unpredictable behavior and also slow things down.

Followup-to: e4d3be19612b2082 ("t: localize the PI_CONFIG env")

doc: recommend -compact after --reindex

It's likely a user will be low on space after running --reindex,
so recommend the use of public-inbox-compact afterwards.

And add a few more notes about using public-inbox-compact to
clarify it's for inboxes-only (and not any old Xapian DBs) that
using xapian-compact(1) directly is error-prone and likely to
break things.

over: simplify read-only vs read-write checking

No need to call ref() and do a string comparison.  Add some
extra tests using the {ReadOnly} attribute in DBI.pm.

inbox: remove TODO item for msg_by_path

It's an old function which only gets called by inboxes w/o
SQLite indices.

inbox: simplify ->description and ->cloneurl

We can use "//=" from Perl 5.10 to simplify the logic for these
methods.  The use of chomp() in ->cloneurl was also unnecessary
since split(/\s+/s,...) already removes newlines.

www: serve $INBOX_DIR/description as $INBOX_URL/description

Instead of serving $INBOX_DIR/all.git/description, since
$INBOX_DIR/all.git/description is not described in the
default message when it's missing.

www: stricter regexp for 405 errors

We want to match "GET" and "HEAD" exactly, not requests which
start with "GET" or end with "HEAD".  This doesn't seem like
a real problem for public-inboxes which are actually public
data anyways.

doc: spellling fixes for manpages

The wording for publicinbox.nntpserver was awkward, too, and I
took this as opportunity to hopefully clarify it and favor
"hostname" for Internet addresses, because we already use
"address" to mean "email address" in the config.

spawn: actually die on (vfork|fork) failures

Commit 9f5a583694396f84 ("spawn (and thus popen_rd) die on failure")
was incomplete in that it only removed error checking for spawn
failures for non-(vfork|fork) calls, but the actual (vfork|fork)
PID result could still be undef.

Fixes: 9f5a583694396f84 ("spawn (and thus popen_rd) die on failure")

v2writable: more ways to detect online CPU count

OpenBSD and FreeBSD support `getconf NPROCESSORS_ONLN` (no
leading underscore).  They may also have GNU nproc installed as
"gnproc".

We may also encounter Linux systems w/o GNU coreutils, but able
to use `getconf _NPROCESSORS_ONLN` (with leading underscore).

doc: -convert: document switches

These switches have always been there, but were not
documented until now.

convert: fix --no-index switch

The (currently undocumented) "--no-index" flag did not trigger
the V2Writable->done call necessary to make the import
successful.

Fixes: eea47b676127bcdb ("convert: preserve highwater mark from v1 msgmap")

convert: shift @ARGV explicitly

Relying on implicit "@_" for shift fails with
TestCommon::_run_sub iff GetOptions modifies @ARGV.

searchidxshard: rely on autoflush instead of ->flush

It reduces the number of ops and simplifies the code, slightly.
Add a missing IO::Handle import while we're at it, to be
explicit about which methods we use.

convert: remove unused variables capturing :from

Looking at git history, they were never used.

v2writable: do not clobber {shards} or {parallel} if unset

The $jobs parameter in `public-inbox-convert' is passed to
V2Writable->init_inbox as `undef' by default, causing
parallelization to be disabled.

Instead, leave the underlying {parallel} flag untouched if
$shards is undef and do not clobber the default shard count.

This allows us to take advantage of multicore systems when
running public-inbox-convert with no command-line switches.

v2writable: nproc_shards: subtract 1 from given value

This is to be consistent with the `nproc(1)' code path.  It also
quiets down a warning from Admin when "-j $JOBS" is specified,
since the master process (which distributes work to shards and
handles OverIdx and Msgmap) is considered a job on its own.

t/multi-mid.t: extra test for -convert highwater mark

This is derived from a real-world test case where I encounterd
multiple Message-IDs in a v1 inbox causing regen problems.

Fixes: eea47b676127bcdb ("convert: preserve highwater mark from v1 msgmap")

doc: more 1.3.0 release notes updates

Some updates with recent bugfixes and a few wording/formatting
improvements.

config: assume multiple cgit URLs, too

Since we support inboxes with multiple URLs and multiple
infourls to reduce reliance on SPOFs, we'll do the same with
cgit URLs.

solver: join multiple URLs with "||"

It seems to make sense to the target audience that any of
the URLs displayed could work.

wwwtext: give "url" examples in sample config

inbox.$NAME.url is a common parameter and set by
public-inbox-init(1), so ensure we have lines for it and
emphasize it can be multi-value for .onion hidden services or
otherwise mirrored and available under multiple URLs.

wwwtext: show multiple infourl values properly

This is now an array, so ensure it's shown properly in the
sample config, instead of "ARRAY(0xI8BADBEEF)" or similar.

Fixes: 1988d730c0088e8b "config: support multi-value inbox.*.*url"

convert: preserve highwater mark from v1 msgmap

If we're reusing the msgmap from a v1 inbox, we also need to
ensure the highwater mark doesn't get doubled in the v1->v2
conversion by internally triggering the equivalent of
"--reindex" on a fresh v2 inbox.

This was needed to convert an indexed v1 inbox which featured
messages with multiple Message-IDs in it.  Fresh, unindexed
clones of v1 inboxes would not have been affected by this.

mboxgz: ensure gzipped mboxes always have filenames

Lets always have Content-Disposition for files intended
to be downloaded for consumption by non-browsers, such
as pigz, zcat, "git am".

This is also to be consistent with the non-gzipped mbox
$MESSAGE_ID/raw endpoint.

t/psgi_search: test for subject-free messages

Apparently I fixed this bug a while back in commit
f94c3a195a25a31d0215cd175938008fca473378 but did
not write tests.

v2writable: newest epochs go first in alternates

New epochs are the most likely to have loose objects.  git won't
be able to take advantage of pack indices and needs to scan
every alternate for the loose object via open/openat syscalls.
Those syscalls will add up some day when we've got hundreds or
thousands of epochs.

INSTALL: fix Linux::Inotify2 package name

The "2" is important, since "Linux::Inotify" without the "2"
is not available from Debian 9/10 or CentOS 7.x and seems
unmaintained.

t/v2reindex.t: 5.10.1 glob compatibility

I'm not sure when `for (<"quoted string/glob/*">)' became
supported, and maybe it was inadvertant, but it fails
with Perl 5.10.1.  Just use the glob() function to be
explicit.

t/hl_mod: document IO::Handle for autoflush

We don't need IO::File for this test, but IO::Handle
is needed for ->autoflush with Perl <5.14.

Note: I haven't tested highlight.pm under 5.10.1 since
it's a weird dependency which isn't easy to install w/o
distro support.

avoid relying on IO::Handle/IO::File autoload

Perl 5.14+ gained the ability to autoload IO::File
(and IO::Handle) on missing methods, so relying on
this breaks under 5.10.1.

There's no reason to load IO::File or IO::Handle
when built-in perlops work fine and are even a hair
faster.

daemon: provide TCP_DEFER_ACCEPT for Perl <5.14

Socket::TCP_DEFER_ACCEPT() did not appear in the Socket module
distributed with Perl until 5.14, despite it being available
since Linux 2.4.

viewdiff: rewrite and simplify

Instead of going line-by-line, use split() with a giant regexp
to capture groups of contiguous lines.  This offloads state
management to the regexp itself and makes it FAR easier to
keep track of <span> and </span> pairings.

Performance seems roughly on par after this change for the
meta@public-inbox archives.  It seems a tiny bit faster for
git@vger with xt/perf-msgview.t, likely due to the longer
messages and larger contiguous groups of lines having the same
prefix (or no prefix at all) and drastically reduces the number
of subroutine calls and Perl ops executed.