Makefile.PL: enable prove warnings

We already "use warnings" everywhere, but could miss some spots.
This ought to cover that, and usually Perl module authors are
consistent about avoiding warnings that we won't clutter our
test outputs.

Makefile.PL: allow `N' variable to be set in local config.mak

This can useful for limiting test resource use without relying
on remembering the variable command-line.

v2: fix reindex skipping NNTP article numbers

`public-inbox-index --reindex' could cause NNTP article number
gaps to form when it also has to deal with new,
never-before-seen commits in mirrors running off `git fetch'.

Fix this by running two distinct invocations of ->index_sync;
once to only reindex old commits, and a second time to index
new commits.

This does not appear to be a problem on v1 at the moment,
but I'll need more time to analyze this.

searchidx: fix obvious typo

We can't pass an empty string to `git merge-base --is-ancestor'
AFAIK, this did NOT present issues in the current test suite.

t/v1reindex.t: fix typo in setting `indexlevel'

It did not cause a test failure because the default fallback
is `indexlevel=full'

viewvcs: keep temporary Solver dir for large streams

Streaming large blobs can take multiple iterations of the event
loop in our -httpd; so we must not let the File::Temp::Dir
result go out-of-scope when streaming large blobs created from
patches.

v2writable: fix assertions around reindexing

Fix a misspelling and ensure line context is printed by
`die' by leaving out the final '\n'.  Also, `delete' was
pointless.

contrib/css: mark as CC0 (public domain)

No reason to copyright colour schemes :P

v2writable: drop unused $last_commits var

Apparently it's never been used and we write to msgmap directly.

t/indexlevels: fix indexlevel of ro_mirror

Don't hard-code "basic", since we already ran -init with the
intended indexlevel.

msgmap: remove double negative

I have never not found double negatives to be confusing...

TODO: more stuff: bundles, synonyms, dogfooding

git bundles could/should make self-hosting easier.

Being able to configure synonym (and spelling) lists would make
some searches more useful.

Might as well dogfood kernel stuff, too, given the overlap and
history between this project, git and the Linux kernel.  Would
be interesting to have *BSD folks throw their hat in the ring,
too.

Building/testing userspace stuff is often the most
time-consuming, but necessary to ensure future compatibility.

MANIFEST: add extman.perl

Oops :x

doc: add URLs for Xapian manpages

Since we go through the effort of hosting these manpages,
link to them.

doc: xcpdb: add switch documentation

In particular, the '--compact' switch is really useful since it
works without holding the inbox-wide lock for minutes at a time
on giant inboxes (inboxes where copies can take dozens, if not
hundreds of minutes).

doc: generate manpages for some Xapian commands

They're nowhere to be found on Xapian.org, and links to
external services are either too long (for manpages.debian.org)
or have privacy-invasive tracking JS on them.

doc: sync .txt mtime to .pod mtime

Otherwise timestamps for .html files get screwed up, too;
and that hurts caching.

doc: don't barf on missing `git set-file-times'

It's not critical, but it's nice to have for cache-friendliness
(otherwise I would not have written it :P)

I guess I should follow up on getting it into 'git contrib/':
https://public-inbox.org/git/20100702033709.GA6818@burratino/

doc: daemon: fix manpage section for nginx

The nginx manpage is in section 8.

doc: index: fix miscapitalization of "SQLite"

Oops :x

search: don't log all warnings on retry_reopen

Some users (or bots :P) can trigger horrible queries which
the caller can choose to either log or ignore.  This prevents
horrible queries from ExtMsg from logging confusing "ref: "
messages when $@ is not a Perl reference.

doc: various updates to reflect current state

-index documentation avoid redundant v1 information and refers
readers to apropriate v1/v2 manpages.  Search::Xapian can also
be optional, now, as only the PSGI search interface uses it.

Favor "INBOX_DIR" where appropriate, since "REPO_DIR" can be
confused for code repos which we also support.

XAPIAN_FLUSH_THRESHOLD is documented for all relevant
bulk commands.

xapcmd: do not reset %SIG until last Xtmpdir is done

To properly handle compact tmpdir cleanup in single process
situations, we need to carefully account for Xtmpdir not
being a singleton and ensuring we don't clobber signal
handlers which belong to other Xtmpdirs.

xcpdb|compact: support --jobs/-j flag like gmake(1)

We don't have to be tied to the number of partitions in case
we made a bad choice at initialization.  This doesn't affect
reindexing, but the copying phase is already intensive.

And optimize away the extra process when we only have a single
job which won't parallelize.

The wording for the (v2) reindexing phase could be improved,
later.  I also plan to allow repartitioning of existing
Xapian DBs.

xapcmd: cleanup on interrupted xcpdb "--compact"

We should not have leftover junk on interrupted invocations.

xcpdb|compact: support some xapian-compact switches

Allow users to specify the --blocksize <B>, --no-full, --fuller
options for xapian-compact(1) for fine-tuning compact behavior
for low-traffic/inactive inboxes.

We also won't support --multipass, since it doesn't seem
compatible with our requirement to use --no-renumber.

We also won't support --single-file, since it only seems
intended for totally dead inboxes; and it doesn't seem
worth the support overhead when "totally dead" turns out
to be a misdiagnosis.

compact: reuse infrastructure from xcpdb

Since -xcpdb is a superset of -compact, we can reuse much of
that code used for driving compact.

For compact (only), this is slightly less memory efficient since
it requires an extra process per-partition, but we get to prefix
the output with the partition name for more readable output.

xcpdb: remove temporary directories on aborts

Cleanup temporary directories on common termination signals
(INT, HUP, PIPE, TERM), but only if it's not in the process
of being committed via rename() sequence.

xcpdb: show re-indexing progress

Emit information about reindexing git revision ranges when used
with xcpdb.  Additionally, distinguish Xapian copy output from
v2 git epoch counting by increasing directory context info.

For now, v1 batches batches are emitted.  v2 indexing is still
missing progress reporting for batches, as the data structures
for reindexing would benefit from a refactoring, first.

This does not currently affect the use of public-inbox-index,
but may in the future.

xapcmd: use "print STDERR" for progress reporting

`warn' is reserved for actual warnings, as it respects
$SIG{__WARN__} and we rely on that override to print
message context information when we are indexing.

doc: xcpdb: update to reflect the current state

It is no longer a wrapper around copydatabase(1), since
copydatabase did not recover from DatabaseModifiedError.

xapcmd: avoid EXDEV when finalizing changes

By creating temporary directories as deep as possible,
we can allow v2 repositories to have `xap$SCHEMA_VERSION'
(e.g. `xap15') reside on a separate FS.

We also check st_dev ahead-of-time to avoid doing work which
will fail with EXDEV.  Of course, another process may still
move/change things around.

xcpdb: cleanup error handling and diagnosis

Running a full "public-inbox-index --reindex" in parallel
with "public-inbox-xcpdb" on the same inbox can still cause
problems, though.

xcpdb: implement progress reporting

Copying an entire Xapian DB is horribly slow whether it's done
via Perl or copydatabase(1).  So displaying some progress
indication is good for user experience.

While we're at it, prefix xapian-compact output, too; since
parallel processes end up clobbering each other.

xcpdb: use fine-grained locking

Copying an entire Xapian DB takes a long time, so update our
reindexing code to support partial reindexing, snapshot the
pre-copydatabase git revisions, perform the lengthy copy,
and do a partial reindex when the copy + renames are done.

v2writable: hoist out log_range sub for readability

This is preparation to to support partial reindexing

xapcmd: xcpdb supports compaction

To minimize the delay on active inboxes, it's actually ideal to
run xapian-compact at the end of the per-partition cpdb process;
since the new DB isn't accessible yet and so we don't have to
deal with lock contention with -mda or -watch processes.  The
downside is temporary file overhead (3x instead of 2x) required.

xcpdb: implement using Perl bindings

By avoid copydatabase(1) entirely, we can make further changes
to avoid locking the entire inbox for a long operation and
switch to fine-grained locking.

admin: move index_inbox over

We will be reindexing after copydatabase

xapcmd: do not cleanup on errors

We move the old directory into the new directory, so avoid the
situation where a bug or error could cause the tempdir cleanup to run
and destroy both our old and new directories.

xcpdb: new tool which wraps Xapian's copydatabase(1)

copydatabase(1) is an existing Xapian tool which is the
recommended way to upgrade existing DBs to the latest Xapian
database format (currently "glass" for stable/released
versions).  Our use of Xapian relies on preserving document IDs,
so we'll wrap it like we do xapian-compact(1) and use the
"--no-renumber" switch.

I could not name the tool "public-inbox-copydatabase" since it
would be ambiguous as to which DB it's actually copying.  So, I
abbreviated the suffix to "xcpdb" (Xapian CoPy DataBase), which
I hope is acceptable and unambiguous.

xapcmd: support spawn options

copydatabase(1) is exceptionally noisy and it's output is
confusing when run in parallel.  Support redirects at least, and
env while we're at it to give us future options.

We can also stuff a -jobs parameter into the options to limit
parallelism since it can be useful for low-priority upgrade
jobs.

admin: hoist out resolve_inboxes for -compact and -index

Both of these index-affecting commands should work similarly
on the command-line.

public-inbox-index no longer complains about unconfigured
~/.public-inbox/config; but often I found myself being
annoyed by that, anyways...

xapcmd: new module for wrapping Xapian commands

Port public-inbox-compact(1) over to using it, and we will need
to wrap copydatabase(1) to ease glass migrations, too.

search: reenable phrase search on non-chert Xapian

This is assuming nobody uses flint or earlier, anymore;
as flint predates the existence of this project.

doc: document the reason for --no-renumber

We're going to need copydatabase, too

v1writable: retire in favor of InboxWritable

In retrospect, introducing V1Writable was unnecessary and
InboxWritable->importer is in a better position to abstract
away differences between v1 and v2 writers.

So teach InboxWritable to initialize inboxes and get rid
of V1Writable.

t/convert-compact: skip on missing xapian-compact(1)

Can't run the test if the required Xapian tools are missing.

Merge branch 'ds-cleanup'

* ds-cleanup:
  DS: warn on deprecations
  DS: remove IPPROTO_TCP import
  DS: drop $VERSION var
  DS: remove support OtherFds code
  DS: get rid of unused methods and aliases

DS: warn on deprecations

Enabling deprecation warnings didn't seem to have any
noticeable effects with "perl -w -c", so whatever reason
Danga had for it is long irrelevant.

DS: remove IPPROTO_TCP import

Unlike Danga::Socket, we do not support TCP_CORK, either

DS: drop $VERSION var

It was only relevant to Danga::Socket.

DS: remove support OtherFds code

It's easy enough to wrap FDs in classes that can use
all of the functionality of the event loop, not just
the read-only interface AddOtherFds provided.

DS: get rid of unused methods and aliases

"make syntax" is clean, now

usercontent: stop relying on autodie

It's a non-standard package on CentOS-7, actually; and we
shouldn't bloat the PSGI server by loading a module which
isn't strictly needed.

ci: support CentOS-7

Tested on an amd64 chroot built with rinse 3.4

t/search*: require DBI and DBD::SQLite, too

None of the Search::Xapian-dependent stuff works without DBI
and DBD::SQLite.

There are no plans to support Xapian w/o DBD::SQLite since
SQLite is more common and less resource-intensive than Xapian.

git: workaround old git-rev-parse(1) (--git-path)

git < 2.5.0 was missing --git-path support.  This means any
users relying on some rare environment variables will need git
2.5.0+

t/watch_filter_rubylang: disable v2 test for git < 2.6

This test was not disabled properly for ancient versions of
git without get-mark support.

init: preserve permissions for git prior to 2.1.0

"git config" did not preserve permissions of the config file it
modifies prior to git 2.1.0, so workaround that.

Merge remote-tracking branch 'origin/xap-optional' into master

* origin/xap-optional:
  admin: improve warnings and errors for missing modules
  searchidx: do not create empty Xapian partitions for basic
  lazy load Xapian and make it optional for v2
  www: use Inbox->over where appropriate
  nntp: use Inbox->over directly
  inbox: add ->over method to ease access

searchidx: remove unused Compress::Zlib import

We only compress in OverIdx, now; since we no longer do overview
stuff in Xapian (and Xapian compresses document data, anyways).

PublicInbox::Import::add: Consolidate subject handling

Consolidate subject handling in the add function to make it easier to
read and understand.

Signed-off-by: "Eric W. Biederman" <ebiederm@xmission.com>

www: unescape '+' => ' ' before general URI unescape

This allows searching for terms with "+" in them properly.

Revert "view: perform highlighting for space-prefixed diffs"

This was buggy and was causing non-diff text to have extra
leading spaces.  The diff parsing code needs to be cleaned up,
so this will be fixed, later.

This reverts commit 1a67b91c1326efa372d1ec957e2494849d894f0b.

search: disable phrase searching, for now

There probably needs to be an option to enable this
independently of indexlevel; but for now this is
the safest option.

And, as I discovered during the development of the
indexlevel option, Xapian does a pretty good job of
finding phrases without position data, anyways.

view: perform highlighting for space-prefixed diffs

"git format-patch --interdiff" and similar can prefix diffs
with leading white space.  Teach our diff parser to account
for it and set appropriate CSS classes for them.

remove hard Devel::Peek dependency and lazy load for daemons

It's only useful for a corner case in long-running daemons when
an admin decides to compact or vacuum a Xapian or SQLite DB.

As a result, other scripts should run slightly faster.  For
instance, this saves about 80ms (2.710s => 2.630s) in t/mda.t
on my remote workstation.

While we're at it, make sure EvCleanup is properly require'd
in Daemon.pm and HTTP.pm and document our use of Devel::Peek.

inbox: remove POSIX strftime import

We no longer need it since Inbox->recent hits the overview
DB instead of Xapian

doc: add marketing guide

Preventative measures; since marketing is almost always annoying
to me.  And trying to avoid unintended consequences.

admin: improve warnings and errors for missing modules

Since we lazy-load Xapian now, some errors may become
more cryptic or buried.  Try to improve that by making
Admin show better errors.

searchidx: do not create empty Xapian partitions for basic

No point in leaving a mess of empty directories when Xapian
doesn't load.

lazy load Xapian and make it optional for v2

More tests work without Search::Xapian, now.
Usability issues still need to be fixed

www: use Inbox->over where appropriate

We don't need to rely on Xapian search functionality for the
majority of the WWW code, even.  subject_normalized is moved to
SearchMsg, where it (probably) makes more sense, anyways.

nntp: use Inbox->over directly

None of the NNTP code actually relies on Xapian, anymore.

inbox: add ->over method to ease access

One small step towards making installing Xapian optional for v2
and providing more WWW and NNTP functionality without it.

tests: get rid of unnecessary Cwd module use

We only need it for tests that chdir, and maybe for ENV{PATH}
portability (dash seems fine, not sure about others).

v2: revert change to solver_git.t for FreeBSD 11.2 and document

t/nntp.t: skip if Data::Dumper is missing

We can revisit this, later; but Data::Dumper requires a separate
package for CentOS-7 users, at least.

t/config.t: remove Data::Dumper dependency

CentOS-7 needs the perl-Data-Dumper package, and the
test is small enough to roll our own escaping, here.

tests: remove unnecessary loading of ::DS and Socket

PublicInbox::DS works for every platform we we care about,
nowadays; so checking for it is a waste of time.  Cleanup a
few POSIX and Socket imports while we're in the area.

httpd: get rid of Deflater warning

Deflating responses may be done by the reverse proxy (e.g. varnish
or nginx), so the warning for it could be invalid.

searchidx: fix incremental index with indexlevel=basic on v1

We were reindexing the full history every invocation of -index
when Xapian was not used because we were incorrectly relying on
'last_commit' metadata stored in Xapian.

Rewrite the indexing logic to be less confusing while we're
at it, since we rely on `git merge-base --is-ancestor' nowadays.

Furthermore, we need to handle message removals from the
overview index correctly when Xapian is not in use.

Co-authored-by: Eric W. Biederman <ebiederm@xmission.com>

v2writable: allow setting nproc via creat options

Avoiding reliance on environment variables is a bit cleaner
for writing tests

v1writable: new wrapper which is closer to v2writable

Import initialization is a little strange from history, but we
also can't change it too much because it's technically a public
API which external code may rely on...

And we may need to support v1 repos indefinitely.  This should
make it easier to write tests for both formats.

ci: include some scripts to make CI easier

This should make it easier to test a bunch of package
installation profiles across whatever OS isolation
one chooses (chroots, containers, jails, VMs).

doc/include.mk: remove git use and redundant declarations

And document that we still have GNU-isms in that
include.mk Makefile (and may continue to do so).
Finally, take advantage of GNU-isms to warn users
to run "gmake" to build all manpages.

Makefile.PL: improve make(1) portability

The `shell' function appears missing, so we'll rely on Bourne
shell expansioN, instead.

Use "$?" instead of "$<" since the latter is only specified
for inference and .DEFAULT rules, not target rules.

Tested on FreeBSD make(1) and bmake(1) on Debian.

doc: give txt files proper titles

We can fix the redundant rule in include.mk which causes
make(1) on FreeBSD to complain; but HTML docs will likely
still require GNU make.

doc: use bullet list for wwwlisting options

Otherwise, pod2man complains about "=item 404" not starting
with a letter and thinking it's part of a numbered list.

t/purge.t: fix unreferenced variable

INSTALL: note xapian-compact(1) tool

The Perl Xapian bindings do not support compacting, yet,
so we rely on the xapian-compact tool.

INSTALL: depend on Encode instead of Encode::MIME::Header

Email::MIME uses Encode::MIME::Header and depends on that
appropriately; however we depend on other parts of the Encode
distribution, but that's bundled with Perl by upstream, anyways;
and should place no additional burden on users.

INSTALL: update with FreeBSD pkg names and reorder

Fortunately, there is a pattern to most of these package names
in all distros I've tested (and hopefully other BSDs have them,
too).

Then, reorder the INSTALL document to mention the top-level
modules, first, so users can avoid needing to type extra
dependencies.  However, we still list some implicit dependencies
in case the upstream package drops dependencies independently of
us.

Finally, Devel::Peek is not a dependency worth making optional
since it's bundled by Perl upstream.  Fedora/RH-based distros
are the only one which turn it into a non-standard package when
Perl5 is installed.

Merge remote-tracking branch 'origin/danga-bundle'

* origin/danga-bundle:
  DS: epoll: fix misordered EPOLL_CTL_DEL call
  DS: drop unused "_undef" sub
  syscall: drop readahead wrapper
  build: do not manify DS and Syscall pods
  DS: handle EINTR in IO::Poll path, too
  DS: workaround IO::Kqueue EINTR (mis-)handling
  DS: drop profiling support
  DS: remove unused fields and functions
  listener: use EPOLLEXCLUSIVE for listen sockets
  bundle Danga::Socket and Sys::Syscall

DS: epoll: fix misordered EPOLL_CTL_DEL call

Any operations on an fd after POSIX::close() are invalid, so
epoll_ctl will fail.  Worse off, in a multi-threaded Perl, the
fd may be reused by another thread and EPOLL_CTL_DEL can hit the
wrong file description as a result.

cf. https://rt.cpan.org/Ticket/Display.html?id=129487

DS: drop unused "_undef" sub

No longer used since we removed the *_ip_string fields

syscall: drop readahead wrapper

No backwards compatibility to worry about for us; and fadvise
is superior anyways.

build: do not manify DS and Syscall pods

We don't need to increase our install footprint with
documentation from our internals (which will surely
change).

DS: handle EINTR in IO::Poll path, too

IO::Poll::_poll returns -1, which is "true" to Perl.

cf. https://rt.cpan.org/Ticket/Display.html?id=129484

nntp: avoid uninitialized variable from blank requests

We'll ignore blank lines from clients, since that's what innd
seems to do.