Merge remote-tracking branch 'origin/newspeak' into xcpdb

* origin/newspeak:
  comments: replace "partition" with "shard"
  t/xcpdb-reshard: use 'shard' term in local variables
  xapcmd: favor 'shard' over 'part' in local variables
  search: use "shard" for local variable
  v2writable: use "epoch" consistently when referring to git repos
  adminedit: "part" => "shard" for local variables
  v2writable: rename local vars to match Xapian terminology
  v2writable: avoid "part" in internal subs and fields
  search*: rename {partition} => {shard}
  xapcmd: update comments referencing "partitions"
  v2: rename SearchIdxPart => SearchIdxShard
  inboxwritable: s/partitions/shards/ in local var
  tests: change messages to use "shard" instead of partition
  v2writable: rename {partitions} field to {shards}
  v2writable: count_partitions => count_shards
  searchidxpart: start using "shard" in user-visible places
  rename reference to git epochs as "partitions"
  admin|xapcmd: user-facing messages say "shard"
  v2writable: update comments regarding xcpdb --reshard
  doc: rename our Xapian "partitions" to "shards"

t/psgi_search.t: use higher-level APIs

No point in using lower-level APIs for a PSGI test.

searchview: add link at bottom to reverse results

I could not find a place to put the link the top without
making navigation too cluttered.  Putting it at the bottom
of the page seems reasonable...

searchview: support negative offsets to reverse ordering

Taking a hint from Perl array access, we'll allow negative
offsets for the 'o' parameter and to reverse the sort order.

Merge remote-tracking branch 'origin/ds'

* origin/ds:
  ds: stop caring about event flags set by epoll/poll/kqueue
  ds: do not distinguish between POLLHUP and POLLERR
  ds: remove read method, here, too
  nntp: use sysread to append to existing buffer
  ds: remove steal_socket method
  ds: remove {fd} field
  ds: reduce Errno imports and drop ->close reason
  ds: cleanup Errno imports and favor constant comparisons
  ds: simplify write buffer accounting

t/git-http-backend: explain purpose of test

I found myself tempted to switch to HTTP::Tiny, here, since
it's distributed with Perl since 5.14, unlike Net::HTTP
(which AFAIK was never a part of Perl proper).

But we really want to use Net::HTTP, here, since it's
lower-level and allows us to trigger server-side buffering
by not reading the entity body.

comments: replace "partition" with "shard"

Now that the code matches Xapian terminology, ensure
our comments match, too.

t/xcpdb-reshard: use 'shard' term in local variables

Another step in maintaining consistency with Xapian docs.

xapcmd: favor 'shard' over 'part' in local variables

Yet another step to keeping our naming consistent with Xapian
terminology.

search: use "shard" for local variable

Another small step towards terminology consistency with Xapian.

v2writable: use "epoch" consistently when referring to git repos

Be consistent with our own terminology and use "epoch" for
[0-9]+\.git repos.  The term "partition" is going away entirely.

adminedit: "part" => "shard" for local variables

v2writable: rename local vars to match Xapian terminology

v2writable: avoid "part" in internal subs and fields

We'll be using the term "shard" from now on to be consistent
with Xapian terminology.

search*: rename {partition} => {shard}

Another step towards keeping our internal data structures
consistent with Xapian naming.

xapcmd: update comments referencing "partitions"

Don't confuse future readers of our code.

v2: rename SearchIdxPart => SearchIdxShard

Another step towards keeping our file and package names
consistent with Xapian terminology.

inboxwritable: s/partitions/shards/ in local var

More work towards being consistent with Xapian's own terminology

tests: change messages to use "shard" instead of partition

Another potentially user-facing piece made consistent with
Xapian terminology.

v2writable: rename {partitions} field to {shards}

Our internal data structure should be consistent with Xapian
terminology.

v2writable: count_partitions => count_shards

Another step towards becoming consistent with Xapian terminology

searchidxpart: start using "shard" in user-visible places

We'll name our process title with "shard" instead, and
update a few error messages and comments to match.

rename reference to git epochs as "partitions"

Try to remain consistent with our own documentation regarding
v2 git "epochs", first.

admin|xapcmd: user-facing messages say "shard"

We're slowly getting rid of the word "partition" when it
comes to remain consistent with Xapian docs.

v2writable: update comments regarding xcpdb --reshard

Using compact to change shard count was abandoned during
the v2 development phase.

doc: rename our Xapian "partitions" to "shards"

For consistency with Xapian documentation (in the "master"
branch).

v2writable: fix brainfart when capping NPROC_MAX_DEFAULT

Oops :x

search: require PublicInbox::Inbox ref here

No sense in supporting multiple methods of initialization
for an internal class.

searchidx: require PublicInbox::Inbox (or InboxWritable) ref

PublicInbox::Inbox objects have minimal dependencies, so
drop code to support old tests which existed before the
PublicInbox::Inbox object came into existence.

Makefile.PL: add test scripts to syntax checks

I make syntax errors all the time :x

t/www_listing: favor HTTP::Tiny over Net::HTTP

More testers are likely to have HTTP::Tiny than Net::HTTP, since
HTTP::Tiny is a dual-life module and distributed with Perl since
Perl 5.14 (2011-05-14), whereas Net::HTTP will likely live in
a separate package forever.

edit: fix portability of editor invocation

The eval was unnecessary, and $0 can't be "--".
Tested with /bin/sh on FreeBSD 11.2

Merge remote-tracking branch 'origin/reshard' into next

* origin/reshard:
  xcpdb: support resharding v2 repos
  xcpdb: use destination shard as progress prefix
  xapcmd: preserve indexlevel based on the destination
  v2writable: use a smaller default for Xapian partitions

Merge remote-tracking branch 'origin/manifest' into next

* origin/manifest:
  git: ensure ->modified returns an integer
  www: support $INBOX/git/$EPOCH.git for v2 cloning
  www: wire up /$INBOX/manifest.js.gz, too
  wwwlisting: generate grokmirror-compatible manifest.js.gz
  wwwlisting: allow hiding entries from manifest

Merge remote-tracking branch 'origin/edit' into next

* origin/edit:
  edit: unlink temporary file when done
  v2writable: replace: kill git processes before reindexing
  edit: drop unwanted headers before noop check
  edit|purge: improve output on rewrites
  edit: new tool to perform edits
  doc: document the --prune option for -index
  admin: expose ->config
  AdminEdit: move editability checks from -purge
  admin: beef up resolve_inboxes to handle purge options
  purge: start moving common options to AdminEdit module
  admin: remove warning arg for unconfigured inboxes
  v2writable: implement ->replace call
  import: switch to "replace_oids" interface for purge
  import: extract_author_info becomes extract_commit_info
  v2writable: consolidate overview and indexing call

xcpdb: support resharding v2 repos

v2 repos are sometimes created on machines where CPU
parallelization exceeds the capability of the storage devices.

In that case, users may reshard the Xapian DB to any smaller,
positive integer to avoid excessive overhead and contention when
bottlenecked by slow storage.

Resharding can also be used to increase shard count after
hardware upgrades.

xcpdb: use destination shard as progress prefix

For M:N resharding, we'll want to display the number from
the new shard number.

xapcmd: preserve indexlevel based on the destination

To support M:N resharding, we need to ensure we store the
indexlevel in the destination shard, rather than the
originating one.

v2writable: use a smaller default for Xapian partitions

Apparently 16 CPUs (probably HT) and SATA storage is common
these days.  Having excessive Xapian partitions leads to
contention and excessive FD/space use.  So set a smaller
default but continue allowing user-specified values to bump
this up.

git: remove cat_file sub callback interface

We weren't using it, and in retrospect, it makes no sense to use
this API cat_file for giant responses which can't read quickly
with minimal context-switching (or sanely fit into memory for
Email::Simple/Email::MIME).

For giant blobs which we don't want slurped in memory, we'll
spawn a short-lived git-cat-file process like we do in ViewVCS.

Otherwise, monopolizing a git-cat-file process for a giant
blob is harmful to other PSGI/NNTP users.

A better interface is coming which will be more suitable for
for batch processing of "small" objects such as commits and
email blobs.

nntp: filter out duplicate Message-IDs for leafnode

It's the unfortunate reality that there are some clients which
reuse Message-IDs (in which we generate + use another) or set
multiple Message-IDs on their own.  While the v2 format
addresses that, NNTP clients such as leafnode are not always
prepared to deal with that case.

So, ensure NNTP clients only see a single Message-ID, and
show the others as 'X-Alt-Message-ID'.

nntp: ensure Message-ID is not folded for leafnode

Leafnode cannot handle Message-ID headers which are too long and
require folding via Email::Simple::Header.  Since there are
already many of these messages in git with the header already
folded, we need to handle the unfolding when emitting the
message via NNTP.

As far as we know, Leafnode is the only client software
incapable of handling this case.

nntp: add Path: header for leafnode

Apparently leafnode just needs any junk in the Path: header.
Lets not waste bandwidth and just use a single byte to keep
leafnode happy.

Cc: Dave Taht <dave@taht.net>

Makefile.PL: "dsyn" target to check syntax of changed files

We have lots of files and syntax-checking every single one of
them is slow.  Enable "perl -w" in the existing syntax check
while we're at it.

doc: update dependencies for CentOS 7.x

Digest::SHA is the most notable missing package at runtime
for a minimal system.

Tests don't run at all without Test::Simple (or Test::More).
Plack::Test is also a separate package, too...

Also, the package for IO::Compress::Gzip should be IO::Compress;
as perl-PerlIO-gzip is a different thing entirely which is not
relevant to our needs.

Test::HTTP::Server::Simple doesn't seem required at all for Plack
tests.

ExtUtils::MakeMaker needs to be documented as a install dependency
for people installing this, too; since AFAIK public-inbox is not
yet in any distros.

t/common.perl: fix error message for git requirements

And enable strict + warnings in the scope of t/common.perl, too.

searchmsg: remove unused ->get subroutine

It's obsolete and unusable since our search schema version 15;
which made the Xapian document ID correspond to the NNTP article
number.

searchidx: improve error message when Xapian fails

Make it easier to detect if a partition is corrupt.

edit: unlink temporary file when done

We don't need to leave temporary files lying around.

v2writable: replace: kill git processes before reindexing

Xapian on Linux <3.15 has trouble with coprocesses since it used
fork() for locking and would hold onto pipes used for git
unnecessarily.

edit: drop unwanted headers before noop check

mutt will set Content-Length, Lines, and Status headers
unconditionally, so we need to account for that before
doing header comparisons to avoid making expensive changes
when noop edits are made.

edit|purge: improve output on rewrites

Fill in undef as "(unchanged)" when displaying commits
and prefix the epoch name.

ds: stop caring about event flags set by epoll/poll/kqueue

If we got something to write, then write it.  Otherwise, try
reading; and continue dealing with errors which normally occur
along the way.

Trying to read requests while we need to buffer in luserspace
is suicidal from a memory management standpoint.

The only adjustment needed for existing callers is EvCleanup;
where we need to ensure we're always calling the dummy
EvCleanup::event_write callback to accomplish nothing.

ds: do not distinguish between POLLHUP and POLLERR

In my experience, both are worthless as any normal read/write
call path will be wanting to check errors and deal with them
appropriately; so we can just call event_read, for now.

Eventually, there'll probably be only one callback for dealing
with all in/out/err/hup events to simplify logic, especially w.r.t
TLS socket negotiation.

ds: remove read method, here, too

Since we stop using it in NNTP, we don't need it at all.

nntp: use sysread to append to existing buffer

We already do this in PublicInbox::HTTP, as it's superior to
DS::read in this regard.  Initially (when I started writing
NNTP.pm, I wanted to use Danga::Socket's read buffering and
push_back_read (removed in DS) but quickly figured out it wasn't
useful at all for dealing with trickling clients.

ds: remove steal_socket method

We won't be needing it, not even for TLS support.

ds: remove {fd} field

Storing the file descriptor was redundant as we can quickly call
fileno($self->{sock}) and not have to store an extra hash table
entry.  Multiple sources of truth leads to confusion, confusion
leads to bugs.

ds: reduce Errno imports and drop ->close reason

ECONNRESET and EPIPE are common on a big Internet filled with
unreliable connections, and there's nothing our code can do
about it.

So no point in wasting code to log them and there are plenty of
tracing tools to choose from if such diagnostics are needed.

ds: cleanup Errno imports and favor constant comparisons

Stop importing unused constants, and favor integer comparisons
of `$!' over `$!{EFOO}' hash lookups.  Integer comparisons are
slightly faster, even:

Benchmark: timing 30 iterations of cmp_eq, cmp_ne, hash_hit, hash_miss...
    cmp_eq:  1 wallclock secs ( 1.61 usr +  0.00 sys =  1.61 CPU) @ 18.63/s (n=30)
    cmp_ne:  2 wallclock secs ( 1.57 usr +  0.00 sys =  1.57 CPU) @ 19.11/s (n=30)
  hash_hit:  4 wallclock secs ( 3.85 usr +  0.00 sys =  3.85 CPU) @  7.79/s (n=30)
 hash_miss:  4 wallclock secs ( 3.74 usr +  0.00 sys =  3.74 CPU) @  8.02/s (n=30)

#!/usr/bin/perl -w
use Benchmark qw(:all);
use Errno qw(EAGAIN EINTR);
my ($r, $w);
pipe($r, $w) or die 'pipe';
require IO::Handle;
$r->blocking(0);
my $buf;
my $n = 30000;
timethese(30, {
hash_hit => sub {
sysread($r, $buf, 1);
for (0..$n) {
next if $!{EAGAIN};
die 'FAIL';
}
}
,
'cmp_eq' => sub {
sysread($r, $buf, 1);
for (0..$n) {
next if $! == EAGAIN;
die 'FAIL';
}
},
hash_miss => sub {
sysread($r, $buf, 1);
for (0..$n) {
die 'FAIL' if $!{EINTR};
}
},
'cmp_ne' => sub {
sysread($r, $buf, 1);
for (0..$n) {
die 'FAIL' if $! == EINTR;
}
},
});

ds: simplify write buffer accounting

Keeping track of write_buf_size was redundant and pointless when
we can simply check the number of elements in the buffer array.
Multiple sources of truth leads to confusion; confusion leads to
bugs.

Finally, rename the prefixes to 'wbuf' to ensure we loudly
(instead of silently) break any external dependencies being
ported over from Danga::Socket, as further changes are pending.

git: ensure ->modified returns an integer

We don't want to serialize timestamps as strings to JSON.
I only noticed this bug on a 32-bit system.

doc: index.pod: fix mismatched =back

doc: generate manpage and HTML from -convert POD

It's been written for over a year, but I forgot to include
it in the build so it did not get installed or put on the site.

doc: clean-doc target removes *.8 manpages

edit: new tool to perform edits

This wrapper around V2Writable->replace provides a user-interface
for editing messages as single-message mboxes (or the raw text
via $EDITOR).

doc: document the --prune option for -index

We've had it around for a while, but I forgot to document it :x

admin: expose ->config

No point in forcing admin programs to reparse the config
themselves; and we won't support multiple instances of it;
unlike the WWW code.

AdminEdit: move editability checks from -purge

We'll be reusing the same logic for -edit

admin: beef up resolve_inboxes to handle purge options

We'll be using this in -edit, and maybe other admin-oriented
tools for UI-consistency.

purge: start moving common options to AdminEdit module

Editing and purging are similar operations involving history
rewrites, so there'll be common options and code between them.

admin: remove warning arg for unconfigured inboxes

We no longer make -index warn on it, no other code uses it;
and working on unconfigured inboxes is totally reasonable
for admins who are setting things up.

v2writable: implement ->replace call

Much of the existing purge code is repurposed to a general
"replace" functionality.

->purge is simpler because it can just drop the information.
Unlike ->purge, ->replace needs to edit existing git commits (in
case of From: and Subject: headers) and reindex the modified
message.

We currently disallow editing of References:, In-Reply-To: and
Message-ID headers because it can cause bad side effects with
our threading (and our lack of rethreading support to deal with
excessive matching from incorrect/invalid References).

import: switch to "replace_oids" interface for purge

Continuing the work by Eric Biederman in commit a118d58a402bd31b
("Import.pm: When purging replace a purged file with a zero length file"),
we can use a generic OID replacement mechanism to implement
purge.

import: extract_author_info becomes extract_commit_info

We will be reusing the same logic for extracting all
the authorship and commit title logic for edits; so
put it all into one sub.

v2writable: consolidate overview and indexing call

It's one ugly sub with lots of parameters, but it's better
than calling a bunch of ugly subs with lots of parameters;
as we'll be needing to call it again when reindexing for
message replacements.

www: support $INBOX/git/$EPOCH.git for v2 cloning

And use it in manifest.js.

To ease maintaining mirrors with grokmirror(1), we can accept
a "git/" directory prefix before the epoch, and ".git" suffix
after the epoch number.

We maintain compatibility with "$INBOX/$EPOCH" cloning, of
course, and it's still easier-to-type on the command-line.

www: wire up /$INBOX/manifest.js.gz, too

I can imagine myself just wanting to clone a single v2 inbox
and all its epochs without thinking about include/exclude
rules in a grokmirror config file.

wwwlisting: generate grokmirror-compatible manifest.js.gz

Support on-demand generation of "/manifest.js.gz" for inboxes.
By default, this matches inboxes with URLs matching the given
request hostname by default.

This makes it easier to create full mirrors of several inboxes
without needing to configure static file serving.

cf. https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git

wwwlisting: allow hiding entries from manifest

Since we already have a mechanism for hiding repositories from
the WWW listing, we might as well support another one for hiding
repositories from the upcoming manifest.js.gz generation.

scripts: add README to describe its purpose

Well, it could probably be moved to contrib...

scripts: require ASCII digits in a few places

I haven't touched most these scripts in ages, but we might as well
purge \d usage from here, as well.

tighten up digit matches to ASCII for git output

While I don't expect git to suddenly start spewing non-ASCII
digits in places I'd expect ASCII, this would make things easier
for future hackers and reviewers.

t: avoid "subtest" for Perl 5.10.1 compatibility

The version of Test::More from Perl 5.10.1 did not support
"subtest", and the earliest version which did is Perl 5.12.0

The good news is this gives me an excuse to parallelize
the indexlevels-mirror test by splitting it into two.
(it could be further split, even).

Update t/nntpd. to use PI_TEST_VERSION consistently while
we're at it.

Merge branch 'charclass'

* charclass: (24 commits)
  www: require ASCII word characters for CSS filenames
  www: require ASCII range for mbox downloads
  githttpbackend: require ASCII in path
  require ASCII digits for local FS items
  www: require ASCII digit for git epoch
  solver|viewdiff: restrict digit matches to ASCII
  inbox: require ASCII digits for feedmax var
  filter/rubylang: require ASCII digit for mailcount
  msgtime: require ASCII digits for parsing dates
  searchview: do not allow non-ASCII offsets and limits
  githttpbackend: require Range:, Status: to be ASCII digits
  view: require YYYYmmDD(HHMMSS) timestamps to be ASCII
  newswww: only accept ASCII digits as article numbers
  config: do not accept non-ASCII digits in cgitrc params
  www: require ASCII filenames in git blob downloads
  www: only emit ASCII chars in attachment filenames
  wwwattach: only pass the charset through if ASCII
  wwwlisting: require ASCII digit for port number
  http: require SERVER_PORT to be ASCII digit
  feed: only accept ASCII digits for ref~$N
  ...

MANIFEST: add examples/nginx_proxy

examples: add sample nginx configuration

The sample configuration can be used to proxy-pass requests
to public-inbox-httpd or to a standalone PSGI/Plack server.

www: require ASCII word characters for CSS filenames

Allowing admins to set non-ASCII CSS filenames could
cause unnecessary problems for client and proxies.

www: require ASCII range for mbox downloads

We do not support many mboxrd download range specifications at
the moment; but parsing non-ASCII characters isn't planned.
This makes no difference aside from being able to return 404
slightly earlier than we would've in the past.

githttpbackend: require ASCII in path

We mainly support git-upload-pack; and maybe somebody uses
git-receive-pack with this.  Perhaps other (experimental)
command names are acceptable.  But it's unlikely anybody will
want Unicode command names for git services.

require ASCII digits for local FS items

In case some BOFH decides to randomly create directories
using non-ASCII digits all over the place.

www: require ASCII digit for git epoch

Don't inadvertantly serve git repos containing non-ASCII
digit characters.

solver|viewdiff: restrict digit matches to ASCII

git would not generate non-ASCII digits to describe
hunk offsets, so don't waste more time than necessary
to make sense of non-ASCII digit chars for line offsets.

inbox: require ASCII digits for feedmax var

Don't waste more cycles than necessary if somebody decides to
put non-ASCII digits in their ~/.public-inbox/config

filter/rubylang: require ASCII digit for mailcount

Unlikely to matter, but who knows...

msgtime: require ASCII digits for parsing dates

User input contains the darndest things.  Don't waste more time
than necessary trying to parse dates out of non-ASCII digits.

searchview: do not allow non-ASCII offsets and limits

Non-ASCII digits would be interpreted as zero when used as integers.

githttpbackend: require Range:, Status: to be ASCII digits

Non-ASCII digits would be interpreted as a zeroes as integers.

While we're at it, ensure the Status: code is an ASCII digit,
too; though I would not expect git-http-backend(1) or cgit(1)
start spewing non-ASCII digits at us.

view: require YYYYmmDD(HHMMSS) timestamps to be ASCII

Passing digits to `timegm' which it does not understand would
be a waste of time.

newswww: only accept ASCII digits as article numbers

Non-ASCII digits aren't specified in RFC3977 for article numbers;
so don't waste a trip to SQLite only to turn up empty.